GeneratorHybrid.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// 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.
 
#include "Generators/GeneratorHybrid.h"
#include <fairlogger/Logger.h>
#include <algorithm>
#include <tbb/concurrent_queue.h>
#include <tbb/task_arena.h>
#include <tbb/parallel_for.h>
#include <CommonUtils/FileSystemUtils.h>
#include <filesystem>
#include "TGrid.h"
 
namespace o2
{
namespace eventgen
{
 
GeneratorHybrid& GeneratorHybrid::Instance(const std::string& inputgens)
{
  static GeneratorHybrid instance(inputgens);
  return instance;
}
 
GeneratorHybrid::GeneratorHybrid(const std::string& inputgens)
{
  // This generator has trivial unit conversions
  setTimeUnit(1.);
  setPositionUnit(1.);
  setMomentumUnit(1.);
  setEnergyUnit(1.);
 
  // Pull file from alien for dynamic configuration if needed
  bool isAlien = false;
  if (inputgens.starts_with("alien://")) {
    if (!gGrid) {
      TGrid::Connect("alien://");
      if (!gGrid) {
        LOG(fatal) << "AliEn connection failed, check token.";
        exit(1);
      }
    }
    TString aliencp = Form("alien_cp %s file:./%s",
                           inputgens.c_str(), "hybridAlien.json");
    if (gSystem->Exec(aliencp.Data()) != 0) {
      LOG(fatal) << "Error: Issues in fetching file" << inputgens;
      exit(1);
    }
    isAlien = true;
  }
 
  if (!parseJSON(isAlien ? "hybridAlien.json" : inputgens)) {
    LOG(fatal) << "Failed to parse JSON configuration from input generators";
    exit(1);
  }
  mRandomize = GeneratorHybridParam::Instance().randomize;
  if (mConfigs.size() != mInputGens.size()) {
    LOG(fatal) << "Number of configurations does not match the number of generators";
    exit(1);
  }
  if (mConfigs.size() == 0) {
    for (auto gen : mInputGens) {
      mConfigs.push_back("");
    }
  }
  int index = 0;
  if (!(mRandomize || mGenerationMode == GenMode::kParallel)) {
    if (mCocktailMode) {
      if (mGroups.size() != mFractions.size()) {
        LOG(fatal) << "Number of groups does not match the number of fractions";
        return;
      }
    } else {
      if (mFractions.size() != mInputGens.size()) {
        LOG(fatal) << "Number of fractions does not match the number of generators";
        return;
      }
    }
    // Check if all elements of mFractions are 0
    if (std::all_of(mFractions.begin(), mFractions.end(), [](int i) { return i == 0; })) {
      LOG(fatal) << "All fractions provided are 0, no simulation will be performed";
      return;
    }
  }
  for (auto gen : mInputGens) {
    // Search if the generator name is inside generatorNames (which is a vector of strings)
    LOG(info) << "Checking if generator " << gen << " is in the list of available generators \n";
    if (std::find(generatorNames.begin(), generatorNames.end(), gen) != generatorNames.end()) {
      LOG(info) << "Found generator " << gen << " in the list of available generators \n";
      if (gen.compare("boxgen") == 0) {
        if (mConfigs[index].compare("") == 0) {
          gens.push_back(std::make_shared<o2::eventgen::BoxGenerator>());
        } else {
          // Get the index of boxgen configuration
          int confBoxIndex = std::stoi(mConfigs[index].substr(7));
          gens.push_back(std::make_shared<o2::eventgen::BoxGenerator>(*mBoxGenConfigs[confBoxIndex]));
        }
        mGens.push_back(gen);
      } else if (gen.compare(0, 7, "pythia8") == 0) {
        // Check if mConfigs[index] contains pythia8_ and a number
        if (mConfigs[index].compare("") == 0) {
          auto pars = Pythia8GenConfig();
          gens.push_back(std::make_shared<o2::eventgen::GeneratorPythia8>(pars));
        } else {
          // Get the index of pythia8 configuration
          int confPythia8Index = std::stoi(mConfigs[index].substr(8));
          gens.push_back(std::make_shared<o2::eventgen::GeneratorPythia8>(*mPythia8GenConfigs[confPythia8Index]));
        }
        mConfsPythia8.push_back(mConfigs[index]);
        mGens.push_back(gen);
      } else if (gen.compare("evtpool") == 0) {
        int confEvtPoolIndex = std::stoi(mConfigs[index].substr(8));
        gens.push_back(std::make_shared<o2::eventgen::GeneratorFromEventPool>(mEventPoolConfigs[confEvtPoolIndex]));
        mGens.push_back(gen);
      } else if (gen.compare("external") == 0) {
        int confextIndex = std::stoi(mConfigs[index].substr(9));
        // Hybrid configs can clone the same external generator config multiple times so
        // an external macro that self-seeds from gRandom could sample the same seed.
        // For this reason the shared RNG state is advanced as a precaution
        // mirroring what GeneratorPythia8::seedGenerator() does for multiple Pythia8 instances.
        if (std::count(mGens.begin(), mGens.end(), "external") > 0) {
          gRandom->Rndm();
        }
        // we need analyse the ini file to update the config key param
        if (mExternalGenConfigs[confextIndex]->iniFile.size() > 0) {
          LOG(info) << "Setting up external gen using the given INI file";
 
          // this means that we go via the ConfigurableParam system ---> in order not to interfere with other
          // generators we use an approach with backup and restore of the system
 
          // we write the current state to a file
          // create a tmp file name
          std::string tmp_config_file = "configkey_tmp_backup_" + std::to_string(getpid()) + std::string(".ini");
          o2::conf::ConfigurableParam::writeINI(tmp_config_file);
 
          auto expandedFileName = o2::utils::expandShellVarsInFileName(mExternalGenConfigs[confextIndex]->iniFile);
          o2::conf::ConfigurableParam::updateFromFile(expandedFileName);
          // toDo: check that this INI file makes sense
 
          auto& params = GeneratorExternalParam::Instance();
          LOG(info) << "Setting up external generator with following parameters";
          LOG(info) << params;
          auto extgen_filename = params.fileName;
          auto extgen_func = params.funcName;
          auto extgen = std::shared_ptr<o2::eventgen::Generator>(o2::conf::GetFromMacro<o2::eventgen::Generator*>(extgen_filename, extgen_func, "FairGenerator*", "extgen"));
          if (!extgen) {
            LOG(fatal) << "Failed to retrieve \'extgen\': problem with configuration ";
          }
          // restore old state
          o2::conf::ConfigurableParam::updateFromFile(tmp_config_file);
          // delete tmp file
          std::filesystem::remove(tmp_config_file);
 
          gens.push_back(std::move(extgen));
          mGens.push_back(gen);
        } else {
          LOG(info) << "Setting up external gen using the given fileName and funcName";
          // we need to restore the config key param system to what is was before
          auto& extgen_filename = mExternalGenConfigs[confextIndex]->fileName;
          auto& extgen_func = mExternalGenConfigs[confextIndex]->funcName;
          auto extGen = std::shared_ptr<o2::eventgen::Generator>(o2::conf::GetFromMacro<o2::eventgen::Generator*>(extgen_filename, extgen_func, "FairGenerator*", "extgen"));
          if (!extGen) {
            LOG(fatal) << "Failed to load external generator from " << extgen_filename << " with function " << extgen_func;
          }
          gens.push_back(std::move(extGen));
          mGens.push_back(gen);
        }
      } else if (gen.compare("hepmc") == 0) {
        int confHepMCIndex = std::stoi(mConfigs[index].substr(6));
        gens.push_back(std::make_shared<o2::eventgen::GeneratorHepMC>());
        auto& globalConfig = o2::conf::SimConfig::Instance();
        dynamic_cast<o2::eventgen::GeneratorHepMC*>(gens.back().get())->setup(*mFileOrCmdGenConfigs[confHepMCIndex], *mHepMCGenConfigs[confHepMCIndex], globalConfig);
        mGens.push_back(gen);
      }
    } else {
      LOG(fatal) << "Generator " << gen << " not found in the list of available generators \n";
      exit(1);
    }
    index++;
  }
}
 
GeneratorHybrid::~GeneratorHybrid()
{
  LOG(info) << "Destructor of generator hybrid called";
  mStopFlag = true;
}
 
Bool_t GeneratorHybrid::Init()
{
  // init all sub-gens
  int count = 0;
  for (auto& gen : mGens) {
    if (gen == "pythia8pp") {
      auto config = std::string(std::getenv("O2_ROOT")) + "/share/Generators/egconfig/pythia8_inel.cfg";
      LOG(info) << "Setting \'Pythia8\' base configuration: " << config << std::endl;
      dynamic_cast<o2::eventgen::GeneratorPythia8*>(gens[count].get())->setConfig(config);
    } else if (gen == "pythia8hf") {
      auto config = std::string(std::getenv("O2_ROOT")) + "/share/Generators/egconfig/pythia8_hf.cfg";
      LOG(info) << "Setting \'Pythia8\' base configuration: " << config << std::endl;
      dynamic_cast<o2::eventgen::GeneratorPythia8*>(gens[count].get())->setConfig(config);
    } else if (gen == "pythia8hi") {
      auto config = std::string(std::getenv("O2_ROOT")) + "/share/Generators/egconfig/pythia8_hi.cfg";
      LOG(info) << "Setting \'Pythia8\' base configuration: " << config << std::endl;
      dynamic_cast<o2::eventgen::GeneratorPythia8*>(gens[count].get())->setConfig(config);
    } else if (gen == "pythia8powheg") {
      auto config = std::string(std::getenv("O2_ROOT")) + "/share/Generators/egconfig/pythia8_powheg.cfg";
      LOG(info) << "Setting \'Pythia8\' base configuration: " << config << std::endl;
      dynamic_cast<o2::eventgen::GeneratorPythia8*>(gens[count].get())->setConfig(config);
    }
    gens[count]->Init(); // TODO: move this to multi-threaded
    addSubGenerator(count, gen);
    if (mTriggerModes[count] != o2::eventgen::Generator::kTriggerOFF) {
      gens[count]->setTriggerMode(mTriggerModes[count]);
      LOG(info) << "Setting Trigger mode of generator " << gen << " to: " << mTriggerModes[count];
      o2::eventgen::Trigger trigger = nullptr;
      o2::eventgen::DeepTrigger deeptrigger = nullptr;
      for (int trg = 0; trg < mTriggerMacros[count].size(); trg++) {
        if (mTriggerMacros[count][trg].empty() || mTriggerFuncs[count][trg].empty()) {
          continue;
        }
        std::string expandedMacro = o2::utils::expandShellVarsInFileName(mTriggerMacros[count][trg]);
        LOG(info) << "Setting trigger " << trg << " of generator " << gen << " with following parameters";
        LOG(info) << "Macro filename: " << expandedMacro;
        LOG(info) << "Function name: " << mTriggerFuncs[count][trg];
        trigger = o2::conf::GetFromMacro<o2::eventgen::Trigger>(expandedMacro, mTriggerFuncs[count][trg], "o2::eventgen::Trigger", "trigger");
        if (!trigger) {
          LOG(info) << "Trying to retrieve a \'o2::eventgen::DeepTrigger\' type";
          deeptrigger = o2::conf::GetFromMacro<o2::eventgen::DeepTrigger>(expandedMacro, mTriggerFuncs[count][trg], "o2::eventgen::DeepTrigger", "deeptrigger");
        }
        if (!trigger && !deeptrigger) {
          LOG(warn) << "Failed to retrieve \'external trigger\': problem with configuration";
          LOG(warn) << "Trigger " << trg << " of generator " << gen << " will not be included";
          continue;
        } else {
          LOG(info) << "Trigger " << trg << " of generator " << gen << " successfully set";
        }
        if (trigger) {
          gens[count]->addTrigger(trigger);
        } else {
          gens[count]->addDeepTrigger(deeptrigger);
        }
      }
    }
    count++;
  }
  // Label for groups: concatenation of the names of the generators in the group, separated by '+'.
  // Currently used only if randomisation is enabled
  auto groupLabel = [this](int k) {
    std::string label;
    for (auto subIndex : mGroups[k]) {
      if (!label.empty()) {
        label += "+";
      }
      label += (mConfigs[subIndex] == "" ? mGens[subIndex] : mConfigs[subIndex]);
    }
    return label;
  };
  if (mRandomize) {
    if (std::all_of(mFractions.begin(), mFractions.end(), [](int i) { return i == 1; })) {
      LOG(info) << "Full randomisation of generators order";
    } else {
      LOG(info) << "Randomisation based on fractions";
      int allfracs = 0;
      for (auto& f : mFractions) {
        allfracs += f;
      }
      // Assign new rng fractions
      float sum = 0;
      float chance = 0;
      for (int k = 0; k < mFractions.size(); k++) {
        if (mFractions[k] == 0) {
          // Generator will not be used if fraction is 0
          mRngFractions.push_back(-1);
          LOG(info) << "Generator " << groupLabel(k) << " will not be used";
        } else {
          chance = static_cast<float>(mFractions[k]) / allfracs;
          sum += chance;
          mRngFractions.push_back(sum);
          LOG(info) << "Generator " << groupLabel(k) << " has a " << chance * 100 << "% chance of being used";
        }
      }
    }
  } else {
    LOG(info) << "Generators will be used in sequence, following provided fractions";
  }
 
  mGenIsInitialized.resize(gens.size(), false);
  if (mGenerationMode == GenMode::kParallel) {
    // in parallel mode we just use one queue --> collaboration
    mResultQueue.resize(1);
  } else {
    // in sequential mode we have one queue per generator
    mResultQueue.resize(gens.size());
  }
  // Create a task arena with a specified number of threads
  mTaskArena.initialize(GeneratorHybridParam::Instance().num_workers);
 
  // the process task function actually calls event generation
  // when it is done it notifies the outside world by pushing it's index into an appropriate queue
  // This should be a lambda, which can be given at TaskPool creation time
  auto process_generator_task = [this](std::vector<std::shared_ptr<o2::eventgen::Generator>> const& generatorvec, int task) {
    LOG(debug) << "Starting eventgen for task " << task;
    auto& generator = generatorvec[task];
    if (!mStopFlag) {
      // TODO: activate this once we are use Init is threadsafe
      // if (!mGenIsInitialized[task]) {
      //   if(!generator->Init()) {
      //     LOG(error) << "failed to init generator " << task;
      //   }
      //   mGenIsInitialized[task] = true;
      // }
    }
    bool isTriggered = false;
    while (!isTriggered) {
      generator->clearParticles();
      generator->generateEvent();
      generator->importParticles();
      isTriggered = generator->triggerEvent();
    }
    LOG(debug) << "eventgen finished for task " << task;
    if (!mStopFlag) {
      if (mGenerationMode == GenMode::kParallel) {
        mResultQueue[0].push(task);
      } else {
        mResultQueue[task].push(task);
      }
    }
  };
 
  // fundamental tbb thread-worker function
  auto worker_function = [this, process_generator_task]() {
    // we increase the reference count in the generator pointers
    // by making a copy of the vector. In this way we ensure that the lifetime
    // of the generators is no shorter than the lifetime of the thread for this worker function
    auto generators_copy = gens;
 
    while (!mStopFlag) {
      int task;
      if (mInputTaskQueue.try_pop(task)) {
        process_generator_task(generators_copy, task); // Process the task
      } else {
        std::this_thread::sleep_for(std::chrono::milliseconds(10)); // Wait if no task
      }
    }
  };
 
  // let the TBB task system run in it's own thread
  mTBBTaskPoolRunner = std::thread([this, worker_function]() { mTaskArena.execute([&]() { tbb::parallel_for(0, mTaskArena.max_concurrency(), [&](int) { worker_function(); }); }); });
  mTBBTaskPoolRunner.detach(); // detaching because we don't like to wait on the thread to finish
                               // some of the generators might still be generating when we are done
 
  // let's also push initial generation tasks for each event generator
  for (size_t genindex = 0; genindex < gens.size(); ++genindex) {
    mInputTaskQueue.push(genindex);
    mTasksStarted++;
  }
  mIsInitialized = true;
  return Generator::Init();
}
 
bool GeneratorHybrid::generateEvent()
{
  if (!mIsInitialized) {
    Init();
  }
  if (mGenerationMode == GenMode::kParallel) {
    mIndex = -1;           // this means any index is welcome
    notifySubGenerator(0); // we shouldn't distinguish the sub-gen ids
  } else {
    // Order randomisation or sequence of generators
    // following provided fractions, if not generators are used in proper sequence
    // Order randomisation or sequence of generators
    // following provided fractions. If not available generators will be used sequentially
    if (mRandomize) {
      if (mRngFractions.size() != 0) {
        // Generate number between 0 and 1
        float rnum = gRandom->Rndm();
        // Find generator index
        for (int k = 0; k < mRngFractions.size(); k++) {
          if (rnum <= mRngFractions[k]) {
            mIndex = k;
            break;
          }
        }
      } else {
        mIndex = gRandom->Integer(mFractions.size());
      }
    } else {
      while (mFractions[mCurrentFraction] == 0 || mseqCounter == mFractions[mCurrentFraction]) {
        if (mFractions[mCurrentFraction] != 0) {
          mseqCounter = 0;
        }
        mCurrentFraction = (mCurrentFraction + 1) % mFractions.size();
      }
      mIndex = mCurrentFraction;
    }
    notifySubGenerator(mIndex);
  }
  return true;
}
 
bool GeneratorHybrid::importParticles()
{
  int genIndex = -1;
  std::vector<int> subGenIndex = {};
  if (mIndex == -1) {
    // this means parallel mode ---> we have a common queue
    mResultQueue[0].pop(genIndex);
  } else {
    // need to pop from a particular queue
    if (!mCocktailMode) {
      mResultQueue[mIndex].pop(genIndex);
    } else {
      // in cocktail mode we need to pop from the group queue
      subGenIndex.resize(mGroups[mIndex].size());
      for (size_t pos = 0; pos < mGroups[mIndex].size(); ++pos) {
        int subIndex = mGroups[mIndex][pos];
        LOG(info) << "Getting generator " << mGens[subIndex] << " from cocktail group " << mIndex;
        mResultQueue[subIndex].pop(subGenIndex[pos]);
      }
    }
  }
 
  auto unit_transformer = [](auto& p, auto pos_unit, auto time_unit, auto en_unit, auto mom_unit) {
    p.SetMomentum(p.Px() * mom_unit, p.Py() * mom_unit, p.Pz() * mom_unit, p.Energy() * en_unit);
    p.SetProductionVertex(p.Vx() * pos_unit, p.Vy() * pos_unit, p.Vz() * pos_unit, p.T() * time_unit);
  };
 
  auto index_transformer = [](auto& p, int offset) {
    for (int i = 0; i < 2; ++i) {
      if (p.GetMother(i) != -1) {
        const auto newindex = p.GetMother(i) + offset;
        p.SetMother(i, newindex);
      }
    }
    if (p.GetNDaughters() > 0) {
      for (int i = 0; i < 2; ++i) {
        const auto newindex = p.GetDaughter(i) + offset;
        p.SetDaughter(i, newindex);
      }
    }
  };
 
  // Clear particles and event header
  mParticles.clear();
  // event header of underlying generator must be fully reset
  // this is important when using event pools where the full header information is forwarded from the generator
  // otherwise some events might have mixed header information from different generators
  mMCEventHeader.Reset();
  if (mCocktailMode) {
    // in cocktail mode we need to merge the particles from the different generators
    for (auto subIndex : subGenIndex) {
      if (!mIsHyperloop) {
        LOG(info) << "Importing particles for task " << subIndex;
      }
      auto subParticles = gens[subIndex]->getParticles();
 
      auto time_unit = gens[subIndex]->getTimeUnit();
      auto pos_unit = gens[subIndex]->getPositionUnit();
      auto mom_unit = gens[subIndex]->getMomentumUnit();
      auto energy_unit = gens[subIndex]->getEnergyUnit();
 
      // The particles carry mother and daughter indices, which are relative
      // to the sub-generator. We need to adjust these indices to reflect that particles
      // are now embedded into a cocktail.
      auto offset = mParticles.size();
      for (auto& p : subParticles) {
        // apply the mother-daugher index transformation
        index_transformer(p, offset);
        // apply unit transformation of sub-generator
        unit_transformer(p, pos_unit, time_unit, energy_unit, mom_unit);
      }
 
      mParticles.insert(mParticles.end(), subParticles.begin(), subParticles.end());
      // first generator of the cocktail is used as reference to update the event header information
      if (mHeaderGeneratorIndex == -1) {
        gens[subIndex]->updateHeader(&mMCEventHeader);
        mHeaderGeneratorIndex = subIndex; // store index of generator updating the header
      }
      mInputTaskQueue.push(subIndex);
      mTasksStarted++;
    }
  } else {
    if (!mIsHyperloop) {
      LOG(info) << "Importing particles for task " << genIndex;
    }
    // at this moment the mIndex-th generator is ready to be used
    mParticles = gens[genIndex]->getParticles();
 
    auto time_unit = gens[genIndex]->getTimeUnit();
    auto pos_unit = gens[genIndex]->getPositionUnit();
    auto mom_unit = gens[genIndex]->getMomentumUnit();
    auto energy_unit = gens[genIndex]->getEnergyUnit();
 
    // transform units to units of the hybrid generator
    for (auto& p : mParticles) {
      // apply unit transformation
      unit_transformer(p, pos_unit, time_unit, energy_unit, mom_unit);
    }
 
    // fetch the event Header information from the underlying generator
    gens[genIndex]->updateHeader(&mMCEventHeader);
    mHeaderGeneratorIndex = genIndex; // store index of generator updating the header
    mInputTaskQueue.push(genIndex);
    mTasksStarted++;
  }
 
  mseqCounter++;
  mEventCounter++;
  if (mEventCounter == getTotalNEvents()) {
    LOG(info) << "HybridGen: Stopping TBB task pool";
    mStopFlag = true;
  }
 
  return true;
}
 
void GeneratorHybrid::updateHeader(o2::dataformats::MCEventHeader* eventHeader)
{
  if (eventHeader) {
    // Overwrite current vertex information to the underlying generator header,
    // otherwise the info will be dropped when copying the FairMCEventHeader part of the header
    mMCEventHeader.SetVertex(eventHeader->GetX(), eventHeader->GetY(), eventHeader->GetZ());
    mHeaderGeneratorIndex = -1; // reset header generator index for next event
    // Forward the base class fields from FairMCEventHeader
    static_cast<FairMCEventHeader&>(*eventHeader) = static_cast<FairMCEventHeader&>(mMCEventHeader);
    // Copy the key-value store info
    eventHeader->copyInfoFrom(mMCEventHeader);
 
    // put additional information about
    eventHeader->putInfo<std::string>("forwarding-generator", "HybridGen");
  }
}
 
template <typename T>
std::string GeneratorHybrid::jsonValueToString(const T& value)
{
  rapidjson::StringBuffer buffer;
  rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
  value.Accept(writer);
  return buffer.GetString();
}
 
Bool_t GeneratorHybrid::confSetter(const auto& gen)
{
  std::string name = gen["name"].GetString();
  mInputGens.push_back(name);
  if (gen.HasMember("config")) {
    if (name == "boxgen") {
      const auto& boxconf = gen["config"];
      auto boxConfig = TBufferJSON::FromJSON<o2::eventgen::BoxGenConfig>(jsonValueToString(boxconf).c_str());
      mBoxGenConfigs.push_back(std::move(boxConfig));
      mConfigs.push_back("boxgen_" + std::to_string(mBoxGenConfigs.size() - 1));
    } else if (name == "pythia8") {
      const auto& pythia8conf = gen["config"];
      auto pythia8Config = TBufferJSON::FromJSON<o2::eventgen::Pythia8GenConfig>(jsonValueToString(pythia8conf).c_str());
      mPythia8GenConfigs.push_back(std::move(pythia8Config));
      mConfigs.push_back("pythia8_" + std::to_string(mPythia8GenConfigs.size() - 1));
    } else if (name == "evtpool") {
      const auto& o2kineconf = gen["config"];
      auto poolConfig = TBufferJSON::FromJSON<o2::eventgen::EventPoolGenConfig>(jsonValueToString(o2kineconf).c_str());
      mEventPoolConfigs.push_back(*poolConfig);
      mConfigs.push_back("evtpool_" + std::to_string(mEventPoolConfigs.size() - 1));
    } else if (name == "external") {
      const auto& extconf = gen["config"];
      auto extConfig = TBufferJSON::FromJSON<o2::eventgen::ExternalGenConfig>(jsonValueToString(extconf).c_str());
      mExternalGenConfigs.push_back(std::move(extConfig));
      mConfigs.push_back("external_" + std::to_string(mExternalGenConfigs.size() - 1));
    } else if (name == "hepmc") {
      const auto& genconf = gen["config"];
      const auto& cmdconf = genconf["configcmd"];
      const auto& hepmcconf = genconf["confighepmc"];
      auto cmdConfig = TBufferJSON::FromJSON<o2::eventgen::FileOrCmdGenConfig>(jsonValueToString(cmdconf).c_str());
      auto hepmcConfig = TBufferJSON::FromJSON<o2::eventgen::HepMCGenConfig>(jsonValueToString(hepmcconf).c_str());
      mFileOrCmdGenConfigs.push_back(std::move(cmdConfig));
      mHepMCGenConfigs.push_back(std::move(hepmcConfig));
      mConfigs.push_back("hepmc_" + std::to_string(mFileOrCmdGenConfigs.size() - 1));
    } else {
      mConfigs.push_back("");
    }
  } else {
    if (name == "boxgen" || name == "pythia8" || name == "external" || name == "hepmc") {
      LOG(fatal) << "No configuration provided for generator " << name;
      return false;
    } else {
      mConfigs.push_back("");
    }
  }
  if (gen.HasMember("triggers")) {
    const auto& trigger = gen["triggers"];
    auto trigger_specs = [this, &trigger]() {
      mTriggerMacros.push_back({});
      mTriggerFuncs.push_back({});
      if (trigger.HasMember("specs")) {
        for (auto& spec : trigger["specs"].GetArray()) {
          if (spec.HasMember("macro")) {
            const auto& macro = spec["macro"].GetString();
            if (!(strcmp(macro, "") == 0)) {
              mTriggerMacros.back().push_back(macro);
            } else {
              mTriggerMacros.back().push_back("");
            }
          } else {
            mTriggerMacros.back().push_back("");
          }
          if (spec.HasMember("function")) {
            const auto& function = spec["function"].GetString();
            if (!(strcmp(function, "") == 0)) {
              mTriggerFuncs.back().push_back(function);
            } else {
              mTriggerFuncs.back().push_back("");
            }
          } else {
            mTriggerFuncs.back().push_back("");
          }
        }
      } else {
        mTriggerMacros.back().push_back("");
        mTriggerFuncs.back().push_back("");
      }
    };
    if (trigger.HasMember("mode")) {
      const auto& trmode = trigger["mode"].GetString();
      if (strcmp(trmode, "or") == 0) {
        mTriggerModes.push_back(o2::eventgen::Generator::kTriggerOR);
        trigger_specs();
      } else if (strcmp(trmode, "and") == 0) {
        mTriggerModes.push_back(o2::eventgen::Generator::kTriggerAND);
        trigger_specs();
      } else if (strcmp(trmode, "off") == 0) {
        mTriggerModes.push_back(o2::eventgen::Generator::kTriggerOFF);
        mTriggerMacros.push_back({""});
        mTriggerFuncs.push_back({""});
      } else {
        LOG(warn) << "Wrong trigger mode provided for generator " << name << ", keeping trigger OFF";
        mTriggerModes.push_back(o2::eventgen::Generator::kTriggerOFF);
        mTriggerMacros.push_back({""});
        mTriggerFuncs.push_back({""});
      }
    } else {
      LOG(warn) << "No trigger mode provided for generator " << name << ", turning trigger OFF";
      mTriggerModes.push_back(o2::eventgen::Generator::kTriggerOFF);
      mTriggerMacros.push_back({""});
      mTriggerFuncs.push_back({""});
    }
  } else {
    mTriggerModes.push_back(o2::eventgen::Generator::kTriggerOFF);
    mTriggerMacros.push_back({""});
    mTriggerFuncs.push_back({""});
  }
  return true;
}
 
Bool_t GeneratorHybrid::parseJSON(const std::string& path)
{
  auto expandedPath = o2::utils::expandShellVarsInFileName(path);
  // Check if configuration file exists
  if (gSystem->AccessPathName(expandedPath.c_str())) {
    LOG(fatal) << "Configuration file " << expandedPath << " for hybrid generator does not exist";
    return false;
  }
  // Parse JSON file to build map
  std::ifstream fileStream(expandedPath, std::ios::in);
  if (!fileStream.is_open()) {
    LOG(error) << "Cannot open " << expandedPath;
    return false;
  }
  rapidjson::IStreamWrapper isw(fileStream);
  rapidjson::Document doc;
  doc.ParseStream(isw);
  if (doc.HasParseError()) {
    LOG(error) << "Error parsing provided json file " << expandedPath;
    LOG(error) << "  - Error -> " << rapidjson::GetParseError_En(doc.GetParseError());
    return false;
  }
 
  // check if there is a mode field
  if (doc.HasMember("mode")) {
    const auto& mode = doc["mode"].GetString();
    if (strcmp(mode, "sequential") == 0) {
      // events are generated in the order given by fractions or random weight
      mGenerationMode = GenMode::kSeq;
    }
    if (strcmp(mode, "parallel") == 0) {
      // events are generated fully in parallel and the order will be random
      // this is mainly for event pool generation or mono-type generators
      mGenerationMode = GenMode::kParallel;
      LOG(info) << "Setting mode to parallel";
    }
  }
 
  // Put the generator names in mInputGens
  if (doc.HasMember("generators")) {
    const auto& gens = doc["generators"];
    for (const auto& gen : gens.GetArray()) {
      mGroups.push_back({});
      // Check if gen is an array (cocktail mode)
      if (gen.HasMember("cocktail")) {
        mCocktailMode = true;
        for (const auto& subgen : gen["cocktail"].GetArray()) {
          if (confSetter(subgen)) {
            mGroups.back().push_back(mInputGens.size() - 1);
          } else {
            return false;
          }
        }
      } else {
        if (!confSetter(gen)) {
          return false;
        }
        // Groups are created in case cocktail mode is activated, this way
        // cocktails can be declared anywhere in the JSON file, without the need
        // of grouping single generators. If no cocktail is defined
        // groups will be ignored nonetheless.
        mGroups.back().push_back(mInputGens.size() - 1);
      }
    }
  }
 
  // Get fractions and put them in mFractions
  if (doc.HasMember("fractions")) {
    const auto& fractions = doc["fractions"];
    for (const auto& frac : fractions.GetArray()) {
      if (!frac.IsInt()) {
        LOG(fatal) << "Fractions must be integers. Wrong type found in JSON";
        return false;
      }
      mFractions.push_back(frac.GetInt());
    }
  } else {
    // Set fractions to unity for all generators in case they are not provided
    const auto& gens = doc["generators"];
    for (const auto& gen : gens.GetArray()) {
      mFractions.push_back(1);
    }
  }
  return true;
}
 
} // namespace eventgen
} // namespace o2
 
ClassImp(o2::eventgen::GeneratorHybrid);