NTupleSvc.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, 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.                                             *
\***********************************************************************************/
//====================================================================
//  NTupleSvc.cpp
//--------------------------------------------------------------------
//
//  Package   : GaudiSvc/NTupleSvc ( The LHCb Offline System)
//
//  Description: implementation of the NTuple service
//
//  Author    : M.Frank
//  History   :
// +---------+----------------------------------------------+---------
// |    Date |                 Comment                      | Who
// +---------+----------------------------------------------+---------
// | 29/10/98| Initial version                              | MF
// | 29/09/99| Added access to ICnvManager for missing      |
// |         | converters                                   | MF
// | 20/09/00| Connect dynamically to conversion service    |
// |         | for N-tuple persistency                      | MF
// +---------+----------------------------------------------+---------
//
//====================================================================
#define GAUDISVC_NTUPLESVC_CPP
 
// Framework include files
#include <GaudiKernel/AttribStringParser.h>
#include <GaudiKernel/DataObject.h>
#include <GaudiKernel/GenericAddress.h>
#include <GaudiKernel/ObjectFactory.h>
#include <GaudiKernel/SmartIF.h>
 
#include <GaudiKernel/IDataSelector.h>
#include <GaudiKernel/IProperty.h>
#include <GaudiKernel/IRegistry.h>
#include <GaudiKernel/ISvcLocator.h>
 
#include <Gaudi/Property.h>
#include <GaudiKernel/ConversionSvc.h>
#include <GaudiKernel/NTupleImplementation.h>
#include <GaudiKernel/Selector.h>
#include <GaudiKernel/reverse.h>
 
#include "NTupleSvc.h"
 
// Instantiation of a static factory class used by clients to create
// instances of this service
DECLARE_COMPONENT( NTupleSvc )
 
// Selector factory instantiation
DECLARE_NAMESPACE_OBJECT_FACTORY( NTuple, Selector )
 
NTupleSvc::NTupleSvc( const std::string& name, ISvcLocator* svc ) : base_class( name, svc ) {
  m_rootName = "/NTUPLES";
  m_rootCLID = CLID_DataObject;
}
 
// Initialize the service.
StatusCode NTupleSvc::initialize() {
  StatusCode status = DataSvc::initialize();
  if ( status.isSuccess() ) {
    StatusCode  iret = StatusCode::SUCCESS;
    DataObject* root = new NTuple::Directory();
    status           = setRoot( m_rootName, root );
    for ( auto& i : m_output ) {
      iret = connect( i );
      if ( !iret.isSuccess() ) status = iret;
    }
    for ( auto& j : m_input ) {
      iret = connect( j );
      if ( !iret.isSuccess() ) status = iret;
    }
  }
  return status;
}

StatusCode NTupleSvc::reinitialize() { return StatusCode::SUCCESS; }
 
// Check if a datasource is connected
bool NTupleSvc::isConnected( const std::string& identifier ) const {
  auto i = m_connections.find( identifier );
  return i != m_connections.end();
}

IConversionSvc* NTupleSvc::getDataLoader( IRegistry* pRegistry ) {
  if ( !pRegistry ) return nullptr;
  std::string full = pRegistry->identifier();
  auto        len  = m_rootName.length();
  auto        idx  = full.find( SEPARATOR, len + 1 );
  std::string path = ( idx == std::string::npos ) ? full : full.substr( 0, idx );
  auto        i    = m_connections.find( path );
  return ( i != m_connections.end() ) ? i->second.service : nullptr;
}
 
StatusCode NTupleSvc::updateDirectories() {
  long        need_update = 0;
  DataObject* pO          = nullptr;
  StatusCode  iret        = findObject( m_rootName.value(), pO );
  //  debug() << "in finalize()" << endmsg;
  if ( iret.isSuccess() ) {
    std::vector<IRegistry*> leaves;
    iret = objectLeaves( pO, leaves );
    if ( iret.isSuccess() ) {
      // Only traverse the tree below the files
      for ( auto d = leaves.begin(); d != leaves.end(); d++ ) {
        if ( !( *d )->object() ) continue;
        IOpaqueAddress* pA = ( *d )->address();
        if ( !pA ) continue;
        unsigned long typ = pA->ipar()[1];
        if ( typ != 'R' && typ != 'N' && typ != 'U' ) continue;
        // ...starting from the file entries: first save the directories/ntuples
        IConversionSvc* svc = getDataLoader( *d );
        if ( !svc ) continue;
 
        IDataSelector sel;
        IDataManagerSvc::traverseSubTree( ( *d )->object(), [&sel]( IRegistry* r, int ) {
          DataObject* obj = r->object();
          if ( obj ) sel.push_back( obj );
          return true;
        } ).ignore();
        for ( DataObject* o : reverse( sel ) ) {
          IRegistry* r      = o->registry();
          auto       status = svc->updateRep( r->address(), o );
          if ( !status.isSuccess() ) iret = status;
        }
        for ( DataObject* o : reverse( sel ) ) {
          IRegistry* r      = o->registry();
          auto       status = svc->updateRepRefs( r->address(), o );
          if ( !status.isSuccess() ) iret = status;
        }
 
        if ( iret.isSuccess() ) need_update += sel.size();
      }
    }
  }
  if ( !iret.isSuccess() ) {
    error() << "ERROR while saving NTuples" << endmsg;
    return iret;
  }
  if ( need_update > 0 ) { info() << "NTuples saved successfully" << endmsg; }
  return iret;
}
 
// Finalize single service
void NTupleSvc::releaseConnection( Connection& c ) {
  SmartIF<IService> isvc( c.service );
  if ( isvc ) isvc->finalize().ignore();
  c.service->release();
  c.service = nullptr;
}
 
// Close all open connections
StatusCode NTupleSvc::disconnect( const std::string& nam ) {
  auto i = m_connections.find( nam );
  if ( i == m_connections.end() ) return StatusCode::FAILURE;
  releaseConnection( i->second );
  m_connections.erase( i );
  return StatusCode::SUCCESS;
}
 
// Close all open connections
StatusCode NTupleSvc::disconnectAll() {
  for ( auto& i : m_connections ) releaseConnection( i.second );
  m_connections.clear();
  return StatusCode::SUCCESS;
}

StatusCode NTupleSvc::finalize() {
  StatusCode status = updateDirectories();
  status            = clearStore();
  status            = DataSvc::finalize();
  status            = disconnectAll();
  return status;
}
 
StatusCode NTupleSvc::connect( const std::string& ident ) {
  std::string logName;
  return connect( ident, logName );
}
 
StatusCode NTupleSvc::connect( const std::string& ident, std::string& logname ) {
  DataObject* pO     = nullptr;
  StatusCode  status = findObject( m_rootName.value(), pO );
  if ( status.isSuccess() ) {
    char              typ = 0;
    std::vector<Prop> props;
    long              loc = ident.find( " " );
    std::string       filename, auth, svc = "", db_typ = "";
    logname      = ident.substr( 0, loc );
    using Parser = Gaudi::Utils::AttribStringParser;
    // we assume that there is always a " "
    // (but if it is not there, we probably will not match the pattern)
    for ( auto attrib : Parser( ident.substr( loc + 1 ) ) ) {
      switch ( ::toupper( attrib.tag[0] ) ) {
      case 'A':
        break;
      case 'F': // FILE='<file name>'
      case 'D': // DATAFILE='<file name>'
        filename = std::move( attrib.value );
        break;
      case 'O': // OPT='<NEW<CREATE,WRITE>, UPDATE, READ>'
        switch ( ::toupper( attrib.value[0] ) ) {
        case 'C':
        case 'N':
        case 'W':
          typ = 'N';
          break;
        case 'U':
          typ = 'U';
          break;
        case 'O':
        case 'R':
          typ = 'O';
          break;
        default:
          typ = 0;
          break;
        }
        break;
      case 'T': // TYP='<HBOOK,ROOT,OBJY,...>'
        db_typ = std::move( attrib.value );
        break;
      default:
        props.emplace_back( attrib.tag, attrib.value );
        break;
      }
    }
    if ( 0 != typ ) {
      IConversionSvc* pSvc = nullptr;
      status               = createService( name() + '.' + logname, db_typ, props, pSvc );
      if ( status.isSuccess() ) {
        status = attachTuple( filename, logname, typ, pSvc->repSvcType() );
        if ( status.isSuccess() ) {
          m_connections.insert( { m_rootName + '/' + logname, Connection( pSvc ) } );
          return StatusCode::SUCCESS;
        }
      }
    }
  }
  error() << "Cannot add " << ident << " invalid filename!" << endmsg;
  return StatusCode::FAILURE;
}
 
StatusCode NTupleSvc::createService( const std::string& /* nam */, const std::string&       typ,
                                     const std::vector<Prop>& /* props */, IConversionSvc*& pSvc ) {
  // Get the value of the Stat persistancy mechanism from the AppMgr
  auto appPropMgr = serviceLocator()->as<IProperty>();
  if ( !appPropMgr ) {
    // Report an error and return the FAILURE status code
    error() << "Could not get PropMgr" << endmsg;
    return StatusCode::FAILURE;
  }
 
  Gaudi::Property<std::string> sp( "HistogramPersistency", "" );
  StatusCode                   sts = appPropMgr->getProperty( &sp );
  if ( !sts.isSuccess() ) {
    error() << "Could not get NTuple Persistency format"
            << " from ApplicationMgr properties" << endmsg;
    return sts;
  }
 
  long storage_typ = TEST_StorageType;
  if ( sp.value() == "HBOOK" ) {
    storage_typ = HBOOK_StorageType;
  } else if ( sp.value() == "ROOT" ) {
    storage_typ = ROOT_StorageType;
  } else {
    error() << "Unknown NTuple Persistency format: " << sp.value() << endmsg;
    return StatusCode::FAILURE;
  }
 
  if ( !typ.empty() && typ != sp.value() ) {
    warning() << "NTuple persistency type is " << sp.value() << "." << endmsg << "Type given by job option "
              << "NTupleSvc.Input/Output ignored!" << endmsg;
  }
 
  //      debug() << "storage type: " << m_storageType << endmsg;
 
  // FIXME: (MCl) why NTupleSvc has to directly create a ConversionSvc?
  IInterface* iface    = new ConversionSvc( name() + "Conversions", serviceLocator(), storage_typ );
  auto        pService = SmartIF<IService>( iface );
  if ( !pService ) return StatusCode::FAILURE;
 
  auto cnvSvc = pService.as<IConversionSvc>();
  if ( !cnvSvc ) return StatusCode::FAILURE;
 
  pSvc = cnvSvc.get();
  pSvc->addRef(); // make sure the caller gets a pSvc which points at something
                  // with a refCount of (at least) one...
  auto status = pService->sysInitialize();
  if ( !status.isSuccess() ) return status;
  return pSvc->setDataProvider( this );
}

StatusCode NTupleSvc::create( const CLID& typ, const std::string& title, NTuple::Tuple*& refpTuple ) {
  NTuple::TupleImp* pTuple = nullptr;
  StatusCode        status = StatusCode::FAILURE;
  if ( typ == CLID_ColumnWiseTuple ) {
    pTuple = new NTuple::ColumnWiseTuple( title );
  } else if ( typ == CLID_RowWiseTuple ) {
    pTuple = new NTuple::RowWiseTuple( title );
  } else {
  }
  if ( pTuple ) {
    pTuple->setTupleService( this );
    status = StatusCode::SUCCESS;
  }
  refpTuple = pTuple;
  return status;
}

NTuple::Tuple* NTupleSvc::book( const std::string& fullPath, const CLID& type, const std::string& title ) {
  DataObject* pObj = nullptr;
  std::string path = fullPath;
  assert( !path.empty() );
  if ( path[0] != SEPARATOR ) {
    path = m_rootName;
    path += SEPARATOR;
    path += fullPath;
  }
  StatusCode status = retrieveObject( path, pObj );
  if ( status.isSuccess() ) {
    error() << "Cannot book N-tuple " << path << " (Exists already)" << endmsg;
    return nullptr;
  }
  auto sep = path.rfind( SEPARATOR );
  if ( sep == std::string::npos ) {
    error() << "Cannot book N-tuple " << path << " (Invalid path)" << endmsg;
    return nullptr;
  }
 
  std::string p_path( path, 0, sep );
  std::string o_path( path, sep, path.length() );
  DataObject* dir = createDirectory( p_path );
  if ( !dir ) {
    error() << "Cannot book N-tuple " << path << " (Invalid parent directory)" << endmsg;
    return nullptr;
  }
 
  NTuple::Tuple* tup = book( dir, o_path, type, title );
  if ( !tup ) { error() << "Cannot book N-tuple " << path << " (Unknown reason)" << endmsg; }
  return tup;
}

NTuple::Tuple* NTupleSvc::book( const std::string& dirPath, const std::string& relPath, const CLID& type,
                                const std::string& title ) {
  std::string full = dirPath;
  assert( !relPath.empty() );
  if ( relPath[0] != SEPARATOR ) full += SEPARATOR;
  full += relPath;
  return book( full, type, title );
}

NTuple::Tuple* NTupleSvc::book( const std::string& dirPath, long id, const CLID& type, const std::string& title ) {
  return book( dirPath, std::to_string( id ), type, title );
}

NTuple::Tuple* NTupleSvc::book( DataObject* pParent, const std::string& relPath, const CLID& type,
                                const std::string& title ) {
  NTuple::Tuple* pObj = nullptr;
  // Check if object is already present
  StatusCode status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) );
  // No ? Then create it!
  if ( !status.isSuccess() ) {
    status = create( type, title, pObj );
    if ( status.isSuccess() ) {
      // Finally register the created N tuple with the store
      status = registerObject( pParent, relPath, pObj );
      if ( status.isSuccess() ) return pObj;
      pObj->release();
    }
  }
  return nullptr;
}

NTuple::Tuple* NTupleSvc::book( DataObject* pParent, long id, const CLID& type, const std::string& title ) {
  return book( pParent, std::to_string( id ), type, title );
}

NTuple::Directory* NTupleSvc::createDirectory( DataObject* pParent, const std::string& relPath ) {
  assert( !relPath.empty() );
  if ( pParent ) {
    IRegistry* pDir = pParent->registry();
    if ( pDir ) {
      std::string full = pDir->identifier();
      if ( relPath[0] != '/' ) full += "/";
      full += relPath;
      return createDirectory( full );
    }
  }
  return nullptr;
}

NTuple::Directory* NTupleSvc::createDirectory( DataObject* pParent, long id ) {
  return createDirectory( pParent, std::to_string( id ) );
}

NTuple::Directory* NTupleSvc::createDirectory( const std::string& dirPath, long id ) {
  return createDirectory( dirPath, std::to_string( id ) );
}

NTuple::Directory* NTupleSvc::createDirectory( const std::string& dirPath, const std::string& relPath ) {
  assert( !relPath.empty() );
  std::string full = dirPath;
  if ( relPath[0] != '/' ) full += "/";
  full += relPath;
  return createDirectory( full );
}
 
StatusCode NTupleSvc::attachTuple( const std::string& filename, const std::string& logname, const char typ,
                                   const long t ) {
  DataObject* p;
  // First get the root object
  StatusCode status = retrieveObject( m_rootName.value(), p );
  if ( status.isSuccess() ) {
    // Now add the registry entry to the store
    std::string entryname = m_rootName;
    entryname += '/';
    entryname += logname;
    GenericAddress* pA = new GenericAddress( t, CLID_NTupleFile, filename, entryname, 0, typ );
    status             = registerAddress( p, logname, pA );
    if ( status.isSuccess() ) {
      info() << "Added stream file:" << filename << " as " << logname << endmsg;
      return status;
    }
    pA->release();
  }
  error() << "Cannot add file:" << filename << " as " << logname << endmsg;
  return status;
}

NTuple::Directory* NTupleSvc::createDirectory( const std::string& fullPath ) {
  NTuple::Directory* p      = nullptr;
  StatusCode         status = findObject( fullPath, *pp_cast<DataObject>( &p ) );
  if ( !status.isSuccess() ) {
    auto sep2 = fullPath.rfind( SEPARATOR );
    if ( sep2 != std::string::npos ) {
      std::string relPath = fullPath.substr( 0, sep2 );
      p                   = createDirectory( relPath );
      if ( p ) {
        p = new NTuple::Directory();
        // Finally register the created N tuple with the store
        status = registerObject( fullPath, p );
        if ( status.isSuccess() ) {
          // ...starting from the file entries
          IConversionSvc* svc = getDataLoader( p->registry() );
          if ( svc ) {
            IOpaqueAddress* pAddr = nullptr;
            status                = svc->createRep( p, pAddr );
            if ( status.isSuccess() ) {
              p->registry()->setAddress( pAddr );
              status = svc->fillRepRefs( pAddr, p );
              if ( status.isSuccess() ) return p;
            }
          }
          unregisterObject( p ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
        }
        p->release();
        p = nullptr;
      }
    }
  }
  return p;
}

NTuple::Tuple* NTupleSvc::access( const std::string&, const std::string& ) { return nullptr; }

StatusCode NTupleSvc::save( const std::string& fullPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? save( pObj ) : Status::INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::save( NTuple::Tuple* n_tuple ) {
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( tuple ) {
    try {
      IConversionSvc* pSvc = tuple->conversionService();
      IRegistry*      pReg = tuple->registry();
      if ( pSvc && pReg ) {
        IOpaqueAddress* pAddr = pReg->address();
        StatusCode      sc    = pSvc->updateRep( pAddr, n_tuple );
        if ( sc.isSuccess() ) sc = pSvc->updateRepRefs( pAddr, n_tuple );
        return sc;
      }
      return Status::NO_DATA_LOADER;
    } catch ( ... ) {}
  }
  return Status::INVALID_OBJECT;
}

StatusCode NTupleSvc::save( DataObject* pParent, const std::string& relPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? save( pObj ) : Status::INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::writeRecord( NTuple::Tuple* n_tuple ) {
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( tuple ) {
    try {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( !pSvc ) {
        pSvc = getDataLoader( n_tuple->registry() );
        tuple->setConversionService( pSvc );
      }
      if ( pSvc ) {
        IRegistry*      pReg   = n_tuple->registry();
        IOpaqueAddress* pAddr  = pReg->address();
        StatusCode      status = pSvc->createRep( n_tuple, pAddr );
        if ( status.isSuccess() ) {
          pReg->setAddress( pAddr );
          status = pSvc->fillRepRefs( pAddr, n_tuple );
        }
        return status;
      }
      return Status::NO_DATA_LOADER;
    } catch ( ... ) {}
  }
  return Status::INVALID_OBJECT;
}

StatusCode NTupleSvc::writeRecord( const std::string& fullPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? writeRecord( pObj ) : Status::INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::writeRecord( DataObject* pParent, const std::string& relPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? writeRecord( pObj ) : Status::INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::readRecord( NTuple::Tuple* n_tuple ) {
  StatusCode        status = Status::INVALID_OBJECT;
  NTuple::TupleImp* tuple  = (NTuple::TupleImp*)n_tuple;
  if ( tuple ) {
    try {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( !pSvc ) {
        pSvc = getDataLoader( n_tuple->registry() );
        tuple->setConversionService( pSvc );
      }
      if ( pSvc ) {
        IRegistry*      pReg  = n_tuple->registry();
        IOpaqueAddress* pAddr = pReg->address();
        status                = pSvc->updateObj( pAddr, n_tuple );
        if ( status.isSuccess() ) { status = pSvc->updateObjRefs( pAddr, n_tuple ); }
        return status;
      }
      status = Status::NO_DATA_LOADER;
    } catch ( ... ) { status = Status::INVALID_OBJECT; }
  }
  return status;
}

StatusCode NTupleSvc::readRecord( const std::string& fullPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? readRecord( pObj ) : Status::INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::readRecord( DataObject* pParent, const std::string& relPath ) {
  NTuple::Tuple* pObj   = nullptr;
  StatusCode     status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is  present
  return status.isSuccess() ? readRecord( pObj ) : Status::INVALID_OBJ_PATH;
}