G4RootMpiNtupleManager Class Reference

#include <G4RootMpiNtupleManager.hh>

Inheritance diagram for G4RootMpiNtupleManager:

Public Member Functions
	G4RootMpiNtupleManager (const G4AnalysisManagerState &state, std::shared_ptr< G4NtupleBookingManager > bookingManger, G4bool rowWise, G4bool rowMode, tools::impi *impi, G4int mpiSize)
virtual	~G4RootMpiNtupleManager ()
virtual void	CreateNtuplesFromBooking (const std::vector< G4NtupleBooking * > &ntupleBookings) final
virtual G4bool	Merge () final

Private Member Functions
G4RootFile *	GetNtupleFile (G4int id)
G4bool	Send (G4int id, RootNtupleDescription *ntupleDescription)
G4bool	InitializeRanks ()
G4bool	WaitBuffer ()

Private Attributes
tools::impi *	fImpi
std::vector< G4int >	fSlaveRanks
G4int	fMainRank

Detailed Description

Definition at line 43 of file G4RootMpiNtupleManager.hh.

Constructor & Destructor Documentation

G4RootMpiNtupleManager()

G4RootMpiNtupleManager::G4RootMpiNtupleManager	(	const G4AnalysisManagerState &	state,
		std::shared_ptr< G4NtupleBookingManager >	bookingManger,
		G4bool	rowWise,
		G4bool	rowMode,
		tools::impi *	impi,
		G4int	mpiSize
	)

Definition at line 45 of file G4RootMpiNtupleManager.cc.

 : G4RootNtupleManager(state, bookingManager, 0, 0, rowWise, rowMode),
   fImpi(impi),
   fSlaveRanks(),
   fMainRank(0)
{
  for ( G4int rank = 0; rank < mpiSize; rank++ ) {
    fSlaveRanks.push_back(rank);
  }
  fMainRank = mpiSize;
}

~G4RootMpiNtupleManager()

G4RootMpiNtupleManager::~G4RootMpiNtupleManager ( )

virtual

Definition at line 62 of file G4RootMpiNtupleManager.cc.

{}

Member Function Documentation

CreateNtuplesFromBooking()

void G4RootMpiNtupleManager::CreateNtuplesFromBooking ( const std::vector< G4NtupleBooking * > &  ntupleBookings )

finalvirtual

Definition at line 302 of file G4RootMpiNtupleManager.cc.

{
  // G4cout << "G4RootMpiNtupleManager::CreateNtuplesFromBooking()" << G4endl;
 
  // Call base class method
  G4TNtupleManager<tools::wroot::ntuple,G4RootFile>::CreateNtuplesFromBooking(
    ntupleBookings);
 
  // Initialize ranks
  if ( ! InitializeRanks() ) {
    G4cerr << "InitializeRanks failed." << G4endl;
  }
 
  // Go to wait buffer mode
  if ( ! WaitBuffer() ) {
    G4cerr << "WaitBuffer failed." << G4endl;
  }  
}

Merge()

G4bool G4RootMpiNtupleManager::Merge ( )

finalvirtual

Definition at line 323 of file G4RootMpiNtupleManager.cc.

{
  // G4cout << "G4RootMpiNtupleManager::Merge()" << G4endl;
 
  auto finalResult = true;
 
  for ( auto ntupleDescription : fNtupleDescriptionVector ) {
 
    // Do not create ntuple if it is inactivated 
    if ( fState.GetIsActivation() && ( ! ntupleDescription->GetActivation() ) ) continue;
 
    // G4cout << "Go to call merge_number_of_entries" << G4endl;
    ntupleDescription->GetNtuple()->merge_number_of_entries();
  }
 
  return finalResult;
}

GetNtupleFile()

G4RootFile * G4RootMpiNtupleManager::GetNtupleFile ( G4int  id )

private

Send()

G4bool G4RootMpiNtupleManager::Send ( G4int  id, RootNtupleDescription *  ntupleDescription  )

private

Definition at line 70 of file G4RootMpiNtupleManager.cc.

{
// Pack and send the main ntuple data to the slave ranks
 
  // G4cout << "Going to send main ntuple data " << G4endl;
  // G4cout << "ntupleDescription: " << ntupleDescription << G4endl;
  // G4cout << "ntuple: " << ntupleDescription->fNtuple << G4endl;
 
  // Get ntuple
  auto ntuple = ntupleDescription->GetNtuple();
 
  // Get basket sizes    
  std::vector<tools::wroot::branch*> mainBranches;
  ntuple->get_branches(mainBranches);
  std::vector<tools::uint32> basketSizes;
  tools_vforcit(tools::wroot::branch*, mainBranches, it) {
    basketSizes.push_back((*it)->basket_size());
  }
 
  auto g4RootFile = fFileManager->CreateNtupleFile(ntupleDescription);
  auto ntupleFile = std::get<0>(*g4RootFile);
 
  tools::uint32 basketSize = fFileManager->GetBasketSize();
  unsigned int basketEntries = fFileManager->GetBasketEntries();
 
  for ( auto slaveRank : fSlaveRanks ) {
    // G4cout << "Going to send main ntuple data to slave rank " << slaveRank << G4endl;
 
    fImpi->pack_reset();
    if ( ! fImpi->pack(id)) {
      G4cerr << "pack(id) failed." << G4endl; 
      return false;
    }
  
    if ( ! fImpi->bpack(fRowWise) ) {
      G4cerr << "bpack(fRowWise) failed."<< G4endl;
      return false;
    }
 
    if ( ! fImpi->bpack(ntupleFile->byte_swap())) {
      G4cerr << "bpack(byte_swap) failed." << G4endl; 
      return false;
    }
  
    if ( ! fImpi->pack(ntupleFile->compression()) ) {
      G4cerr << "pack(compression) failed." << G4endl;
      return false; 
    }
  
    if ( ! fImpi->pack(ntupleFile->dir().seek_directory())) {
      // Should be used fNtupleDirectory ??
      G4cerr << "pack(seek) failed." << G4endl;
      return false;
    }
 
    if ( fRowWise ) {
      if ( ! fImpi->pack(basketSize) ) {
        G4cerr << "pack(basketSize) failed." << G4endl;
        return false;
      }
    } else {
      if ( ! fImpi->bpack(fRowMode) ) {
        G4cerr << "bpack(fRowMode) failed." << G4endl;
        return false;
      }      
      if ( ! fImpi->vpack(basketSizes) ) {
        G4cerr << "vpack(basketSizes) failed." << G4endl;
        return false;
      }
      if ( ! fImpi->pack(basketEntries) ) {
        G4cerr << "pack(basketEntries) failed." << G4endl;
        return false;
      }      
    }
 
    if ( ! fImpi->send_buffer(slaveRank, kTAG_NTUPLE )) {
      G4cerr << "send_buffer() failed." << G4endl;
      return false;
    }
    fImpi->pack_reset();
 
    G4cout << "Sent ntuple description to slave on rank " << slaveRank << G4endl;
  }
 
  // G4cout << "Done: send main ntuple data " << G4endl;
  return true;
}

InitializeRanks()

G4bool G4RootMpiNtupleManager::InitializeRanks ( )

private

Definition at line 159 of file G4RootMpiNtupleManager.cc.

{
  // G4cout << "G4RootMpiNtupleManager::InitializeRanks" << G4endl;
 
  auto finalResult = true;
 
  auto counter = 0;
  for ( auto ntupleDescription : fNtupleDescriptionVector ) {
 
    // Do not create ntuple if it is inactivated 
    if ( fState.GetIsActivation() && ( ! ntupleDescription->GetActivation() ) ) continue;
 
    auto result = Send(counter++, ntupleDescription);
    finalResult = finalResult && result;
  }
 
  return finalResult;
} 

WaitBuffer()

G4bool G4RootMpiNtupleManager::WaitBuffer ( )

private

Definition at line 179 of file G4RootMpiNtupleManager.cc.

{
// Receive the pntuple data from the slave ranks
// For the time being only one ntuple 
 
  // G4cout << "G4RootMpiNtupleManager::WaitBuffer" << G4endl;
 
  unsigned long numberOfEndFill = 0;
  
  G4bool verbose = IsVerbose(kVL2);
 
  while ( true ) { 
    fImpi->pack_reset();
 
    // loop until receiving end_fill from all ranks
    // G4cout << "G4RootMpiNtupleManager::WaitBuffer entering loop" << G4endl;
    int probe_src;
    if ( ! fImpi->wait_buffer(fMainRank, kTAG_NTUPLE, probe_src, verbose)) {
      G4cerr << "!!! wait_buffer() failed." << std::endl;
      return EXIT_FAILURE;
    }
  
    tools::uint32 protocol;
    if ( ! fImpi->unpack(protocol)) {
      G4cerr << "unpack(protocol) failed."<< G4endl;
      return false;
    }
  
    if ( protocol == tools::wroot::mpi_protocol_basket() ) {
 
      // G4cout << "G4RootMpiNtupleManager::WaitBuffer got protocol_basket" << G4endl;
  
      // get ntuple Id
      tools::uint32 ntupleId;
      if ( ! fImpi->unpack(ntupleId) ) {
        G4cerr << "unpack(ntuple_id) failed."<< std::endl;
        return false;
      }
 
      if ( ntupleId >= fNtupleVector.size() ) {
        std::cerr << "!!! unknown ntupleId " << ntupleId << std::endl;
        return false;
      }
 
      // Main ntuple
      auto mainNtuple = fNtupleVector[ntupleId];
 
      // add basket to main ntuple
      if ( ! mainNtuple->mpi_add_basket(*fImpi)) {
          std::cerr << "mainNtuple->mpi_add_basket() failed." << std::endl;    
          return EXIT_FAILURE;
      }
    } 
    else if ( protocol == tools::wroot::mpi_protocol_baskets() ) {
      //column_wise and row_mode only.
 
      // G4cout << "G4RootMpiNtupleManager::WaitBuffer got protocol_baskets" << G4endl;
  
      // get ntuple Id
      tools::uint32 ntupleId;
      if ( ! fImpi->unpack(ntupleId) ) {
        G4cerr << "unpack(ntuple_id) failed."<< std::endl;
        return false;
      }
 
      if ( ntupleId >= fNtupleVector.size() ) {
        std::cerr << "!!! unknown ntupleId " << ntupleId << std::endl;
        return false;
      }
 
      // Main ntuple
      auto mainNtuple = fNtupleVector[ntupleId];
 
      // add basket to main ntuple
      if ( ! mainNtuple->mpi_add_baskets(*fImpi)) {
          std::cerr << "mainNtuple->mpi_add_baskets() failed." << std::endl;    
          return EXIT_FAILURE;
      }
    } 
    else if ( protocol==tools::wroot::mpi_protocol_end_fill() ) {
  
      // G4cout << "G4RootMpiNtupleManager::WaitBuffer got protocol_end_fill" << G4endl;
      
      // get ntuple Id
      tools::uint32 ntupleId;
      if ( ! fImpi->unpack(ntupleId) ) {
        G4cerr << "unpack(ntuple_id) failed."<< std::endl;
        return false;
      }
 
      if ( ntupleId >= fNtupleVector.size() ) {
        std::cerr << "!!! unknown ntupleId " << ntupleId << std::endl;
        return false;
      }
  
      // Main ntuple
      auto mainNtuple = fNtupleVector[ntupleId];
 
      // end_fill in main ntuple
      if ( ! mainNtuple->mpi_end_fill(*fImpi) ) {
        G4cerr << "main_ntuple->mpi_end_fill() failed." << std::endl;    
        return false;
      }
 
      numberOfEndFill++;
 
      if ( numberOfEndFill == fSlaveRanks.size() ) break;
    } 
    else {
      G4cerr << "unknown protocol " << protocol << G4endl;
      return false;
    }
  }
 
  return true;
}

Member Data Documentation

fImpi

tools::impi* G4RootMpiNtupleManager::fImpi

private

Definition at line 65 of file G4RootMpiNtupleManager.hh.

fSlaveRanks

std::vector<G4int> G4RootMpiNtupleManager::fSlaveRanks

private

Definition at line 66 of file G4RootMpiNtupleManager.hh.

fMainRank

G4int G4RootMpiNtupleManager::fMainRank

private

Definition at line 67 of file G4RootMpiNtupleManager.hh.

---

The documentation for this class was generated from the following files:

• extended/parallel/MPI/source/analysis/include/G4RootMpiNtupleManager.hh
• extended/parallel/MPI/source/analysis/src/G4RootMpiNtupleManager.cc