Logo ROOT  
Reference Guide
testTMPIFile.C File Reference

Detailed Description

This macro shows the usage of TMPIFile to simulate event reconstruction and merging them in parallel.

The JetEvent class is in $ROOTSYS/tutorials/tree/JetEvent.h,cxx

To run this macro do the following:

mpirun -np 4 root -b -l -q testTMPIFile.C
#include "TMPIFile.h"
R__LOAD_LIBRARY(RMPI) // Work around autoloading issue when ROOT modules are enabled
#include <chrono>
#include <sstream>
/* ---------------------------------------------------------------------------
The idea of TMPIFile is to run N MPI ranks where some ranks are
producing data (called workers), while other ranks are collecting data and
writing it to disk (called collectors). The number of collectors can be
configured and this should be optimized for each workflow and data size.
This example uses a typical event processing loop, where every N events the
TMPIFile::Sync() function is called. This call triggers the local TTree data
to be sent via MPI to the collector rank where it is merged with all the
other worker rank data and written to a TFile.
An MPI Sub-Communictor is created for each collector which equally distributes
the remaining ranks to distribute the workers among collectors.
--------------------------------------------------------------------------- */
void test_tmpi()
Int_t N_collectors = 2; // specify how many collectors to run
Int_t sync_rate = 2; // workers sync every sync_rate events
Int_t events_per_rank = 6; // total events each rank will produce then exit
Int_t sleep_mean = 5; // simulate compute time for event processing
Int_t sleep_sigma = 2; // variation in compute time
// using JetEvent generator to create a data structure
// these parameters control this generator
Int_t jetm = 25;
Int_t trackm = 60;
Int_t hitam = 200;
Int_t hitbm = 100;
std::string treename = "test_tmpi";
std::string branchname = "event";
// set output filename
std::stringstream smpifname;
smpifname << "/tmp/merged_output_" << getpid() << ".root";
// Create new TMPIFile, passing the filename, setting read/write permissions
// and setting the number of collectors.
// If MPI_INIT has not been called already, the constructor of TMPIFile
// will call this.
TMPIFile *newfile = new TMPIFile(smpifname.str().c_str(), "RECREATE", N_collectors);
// set random number seed that is based on MPI rank
// this avoids producing the same events in each MPI rank
gRandom->SetSeed(gRandom->GetSeed() + newfile->GetMPIGlobalRank());
// only print log messages in MPI Rank 0
if (newfile->GetMPIGlobalRank() == 0) {
Info("test_tmpi", " running with parallel ranks: %d", newfile->GetMPIGlobalSize());
Info("test_tmpi", " running with collecting ranks: %d", N_collectors);
Info("test_tmpi", " running with working ranks: %d", (newfile->GetMPIGlobalSize() - N_collectors));
Info("test_tmpi", " running with sync rate: %d", sync_rate);
Info("test_tmpi", " running with events per rank: %d", events_per_rank);
Info("test_tmpi", " running with sleep mean: %d", sleep_mean);
Info("test_tmpi", " running with sleep sigma: %d", sleep_sigma);
Info("test_tmpi", " running with seed: %d", gRandom->GetSeed());
// print filename for each collector Rank
if (newfile->IsCollector()) {
Info("Collector", "[%d]\troot output filename = %s", newfile->GetMPIGlobalRank(), smpifname.str().c_str());
// This if statement splits the run-time functionality of
// workers and collectors.
if (newfile->IsCollector()) {
// Run by collector ranks
// This will run until all workers have exited
} else {
// Run by worker ranks
// these ranks generate data to be written to TMPIFile
// create a TTree to store event data
TTree *tree = new TTree(treename.c_str(), "Event example with Jets");
// set the AutoFlush rate to be the same as the sync_rate
// this synchronizes the TTree branch compression
// Create our fake event data generator
JetEvent *event = new JetEvent;
// add our branch to the TTree
tree->Branch(branchname.c_str(), "JetEvent", &event, 8000, 2);
// monitor timing
auto sync_start = std::chrono::high_resolution_clock::now();
// generate the specified number of events
for (int i = 0; i < events_per_rank; i++) {
auto start = std::chrono::high_resolution_clock::now();
// Generate one event
event->Build(jetm, trackm, hitam, hitbm);
auto evt_built = std::chrono::high_resolution_clock::now();
double build_time = std::chrono::duration_cast<std::chrono::duration<double>>(evt_built - start).count();
Info("Rank", "[%d] [%d]\tevt = %d;\tbuild_time = %f", newfile->GetMPIColor(), newfile->GetMPILocalRank(), i,
// if our build time was significant, subtract that from the sleep time
auto adjusted_sleep = (int)(sleep_mean - build_time);
auto sleep = abs(gRandom->Gaus(adjusted_sleep, sleep_sigma));
// simulate the time taken by more complicated event generation
// Fill the tree
// every sync_rate events, call the TMPIFile::Sync() function
// to trigger MPI collection of local data
if ((i + 1) % sync_rate == 0) {
// call TMPIFile::Sync()
auto end = std::chrono::high_resolution_clock::now();
double sync_time = std::chrono::duration_cast<std::chrono::duration<double>>(end - sync_start).count();
Info("Rank", "[%d] [%d]\tevent collection time: %f", newfile->GetMPIColor(), newfile->GetMPILocalRank(),
sync_start = std::chrono::high_resolution_clock::now();
// synchronize any left over events
if (events_per_rank % sync_rate != 0) {
// call Close on the file for clean exit.
Info("Rank", "[%d] [%d]\tclosing file", newfile->GetMPIColor(), newfile->GetMPILocalRank());
// open file and test contents
if (newfile->GetMPILocalRank() == 0) {
TString filename = newfile->GetMPIFilename();
Info("Rank", "[%d] [%d]\topening file: %s", newfile->GetMPIColor(), newfile->GetMPILocalRank(), filename.Data());
TFile file(filename.Data());
if (file.IsOpen()) {
TTree *tree = (TTree *)file.Get(treename.c_str());
if (tree)
Info("Rank", "[%d] [%d]\tfile should have %d events and has %lld", newfile->GetMPIColor(),
newfile->GetMPILocalRank(), (newfile->GetMPILocalSize() - 1) * events_per_rank, tree->GetEntries());
void testTMPIFile(Bool_t secRun)
auto start = std::chrono::high_resolution_clock::now();
auto end = std::chrono::high_resolution_clock::now();
double time = std::chrono::duration_cast<std::chrono::duration<double>>(end - start).count();
std::string msg = "Total elapsed time: ";
msg += std::to_string(time);
Info("testTMPIFile", "%s", msg.c_str());
Info("testTMPIFile", "exiting");
void testTMPIFile()
Int_t flag;
if (!flag) {
// Get rank and size
Int_t rank, size;
MPI_Comm_rank(MPI_COMM_WORLD, &rank);
MPI_Comm_size(MPI_COMM_WORLD, &size);
// Procecss 0 generates JetEvent library
if (rank == 0) {
TString tutdir = gROOT->GetTutorialDir();
gSystem->Exec("cp " + tutdir + "/tree/JetEvent* .");
gROOT->ProcessLine(".L JetEvent.cxx+");
// Wait until it's done
gROOT->ProcessLine("#define TMPI_SECOND_RUN yes");
gROOT->ProcessLine("#include \"" __FILE__ "\"");
// TMPIFile will do MPI_Finalize() when closing the file
Int_t finalized = 0;
if (!finalized) {
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
Definition: Rtypes.h:489
void Info(const char *location, const char *msgfmt,...)
Use this function for informational messages.
Definition: TError.cxx:221
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
R__EXTERN C unsigned int sleep(unsigned int seconds)
#define gROOT
Definition: TROOT.h:406
R__EXTERN TRandom * gRandom
Definition: TRandom.h:62
R__EXTERN TSystem * gSystem
Definition: TSystem.h:560
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:54
virtual Double_t Gaus(Double_t mean=0, Double_t sigma=1)
Samples a random number from the standard Normal (Gaussian) Distribution with the given mean and sigm...
Definition: TRandom.cxx:274
virtual void SetSeed(ULong_t seed=0)
Set the random generator seed.
Definition: TRandom.cxx:608
virtual UInt_t GetSeed() const
Get the random generator seed.
Definition: TRandom.cxx:641
Basic string class.
Definition: TString.h:136
virtual Int_t Exec(const char *shellcmd)
Execute a command.
Definition: TSystem.cxx:656
A TTree represents a columnar dataset.
Definition: TTree.h:79
RVec< PromoteType< T > > abs(const RVec< T > &v)
Definition: RVec.hxx:1780
Definition: file.py:1
Definition: tree.py:1
Taylor Childers, Yunsong Wang

Definition in file testTMPIFile.C.