#include </builds/gaudi/Gaudi/GaudiSvc/src/FileMgr/FileMgr.h>

Inheritance diagram for FileMgr:

[legend]

Collaboration diagram for FileMgr:

[legend]

Public Member Functions
	~FileMgr () override

StatusCode	initialize () override

StatusCode	finalize () override

void	handle (const Incident &) override

StatusCode	regHandler (FileHdlr) override

StatusCode	hasHandler (const IoTech &) const override

StatusCode	deregHandler (const IoTech &) override

StatusCode	getHandler (const IoTech &, FileHdlr &) const override

StatusCode	getHandler (const std::string &, FileHdlr &) const override

int	getFileAttr (const std::string &, std::vector< const FileAttr * > &) const override

StatusCode	getFileAttr (const Fd, const FileAttr *&) const override

StatusCode	getFileAttr (void , const FileAttr &) const override

void	listHandlers () const override

void	listFiles () const override

virtual void	listActions () const

virtual void	listSuppression () const

int	getFiles (std::vector< std::string > &, bool onlyOpen=true) const override

int	getFiles (std::vector< const Io::FileAttr * > &, bool onlyOpen=true) const override

int	getFiles (const Io::IoTech &, std::vector< std::string > &, bool onlyOpen=true) const override

int	getFiles (const Io::IoTech &, std::vector< const Io::FileAttr * > &, bool onlyOpen=true) const override

int	getFiles (const Io::IoTech &, const Io::IoFlags &, std::vector< std::string > &, bool onlyOpen=true) const override

int	getFiles (const Io::IoTech &, const Io::IoFlags &, std::vector< const Io::FileAttr * > &, bool onlyOpen=true) const override

int	getFd (std::vector< Fd > &) const override

int	getFd (const Io::IoTech &, std::vector< Io::Fd > &) const override

int	getFd (const Io::IoTech &, const Io::IoFlags &, std::vector< Io::Fd > &) const override

const std::string &	fname (const Io::Fd &) const override

const std::string &	fname (void *) const override

Io::Fd	fd (const std::string &) const override

Io::Fd	fd (void *) const override

void *	fptr (const std::string &) const override

void *	fptr (const Io::Fd &) const override

int	getLastError (std::string &) const override

Io::open_t	open (const Io::IoTech &, const std::string &caller, const std::string &fname, const Io::IoFlags &, Io::Fd &fd, void *&ptr, const std::string &desc="", const bool shared=false) override

Io::open_t	open (const Io::IoTech &, const std::string &caller, const std::string &fname, const Io::IoFlags &, Io::Fd &, const std::string &desc="", const bool shared=false) override

Io::open_t	open (const Io::IoTech &, const std::string &caller, const std::string &fname, const Io::IoFlags &, void *&, const std::string &desc="", const bool shared=false) override

Io::close_t	close (const Fd, const std::string &caller) override

Io::close_t	close (void *, const std::string &caller) override

Io::reopen_t	reopen (const Fd, const IoFlags &, const std::string &caller) override

Io::reopen_t	reopen (void *, const IoFlags &, const std::string &caller) override

StatusCode	regAction (Io::bfcn_action_t, const Io::Action &, const std::string &desc="") override

StatusCode	regAction (Io::bfcn_action_t, const Io::Action &, const Io::IoTech &, const std::string &desc="") override

void	suppressAction (const std::string &) override

void	suppressAction (const std::string &, const Io::Action &) override

Public Member Functions inherited from extends< Service, IFileMgr, IIncidentListener >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Types
typedef std::pair< Io::bfcn_action_t, std::string >	bfcn_desc_t

typedef std::map< Io::Action, std::list< bfcn_desc_t > >	actionMap

typedef std::multimap< std::string, FileAttr * >	fileMap

Private Member Functions
virtual Io::open_t	open (const IoTech &, const std::string &caller, const std::string &fname, const std::string &desc, const IoFlags &, Fd &, void *&, const bool shared)

StatusCode	execAction (Io::FileAttr *, const std::string &, const Io::Action &) const

StatusCode	execActs (Io::FileAttr *, const std::string &, const Io::Action &, const actionMap &m) const

bool	accessMatch (const Io::IoFlags &, const Io::IoFlags &, bool strict=false) const

bool	isShareable (const std::string &filename, const Io::IoFlags &) const

Private Attributes
Gaudi::Property< std::string >	m_logfile { this, "LogFile" }

Gaudi::Property< bool >	m_printSummary { this, "PrintSummary", false }

Gaudi::Property< bool >	m_loadRootHandler { this, "LoadROOTHandler", true }

Gaudi::Property< bool >	m_loadPosixHandler { this, "LoadPOSIXHandler", true }

Gaudi::Property< std::string >	m_ssl_proxy { this, "TSSL_UserProxy", "X509" }

Gaudi::Property< std::string >	m_ssl_cert { this, "TSSL_CertDir", "X509" }

fileMap	m_files

std::map< IoTech, FileHdlr >	m_handlers

std::map< Fd, FileAttr * >	m_descriptors

std::vector< std::unique_ptr< FileAttr > >	m_attr

std::vector< FileAttr * >	m_oldFiles

std::map< IoTech, actionMap >	m_actions

std::map< std::string, Io::Action_bitmap >	m_supMap

std::string	m_lastErrS

int	m_lastErr

std::optional< RootFileHandler >	m_rfh

std::optional< POSIXFileHandler >	m_pfh

Additional Inherited Members
Public Types inherited from extends< Service, IFileMgr, IIncidentListener >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

Definition at line 44 of file FileMgr.h.

Member Typedef Documentation

◆ actionMap

typedef std::map<Io::Action, std::list<bfcn_desc_t> > FileMgr::actionMap

private

Definition at line 135 of file FileMgr.h.

◆ bfcn_desc_t

typedef std::pair<Io::bfcn_action_t, std::string> FileMgr::bfcn_desc_t

private

Definition at line 134 of file FileMgr.h.

◆ fileMap

typedef std::multimap<std::string, FileAttr*> FileMgr::fileMap

private

Definition at line 142 of file FileMgr.h.

Constructor & Destructor Documentation

◆ ~FileMgr()

FileMgr::~FileMgr ( )

override

Definition at line 63 of file FileMgr.cpp.

                  {
  // Where do the new-ed FileAttr get deleted?
  // they get pushed into m_descriptors, but m_attr is presumably
  // where they _also_ should be pushed in order to track ownership...
}

Member Function Documentation

◆ accessMatch()

bool FileMgr::accessMatch	(	const Io::IoFlags &	fold,
		const Io::IoFlags &	fnew,
		bool	strict = false ) const

private

Definition at line 1151 of file FileMgr.cpp.

                                                                                      {
  ON_VERBOSE
  verbose() << "accessMatch  old: " << fold << "  new: " << fnew << endmsg;
 
  return ( ( ( fold == Io::READ ) && ( fnew == Io::READ ) ) ||
           ( ( fold & Io::WRITE ) != 0 && ( fnew & Io::WRITE ) != 0 ) ||
           ( ( fold & Io::RDWR ) != 0 && ( fnew & Io::RDWR ) != 0 ) );
}

◆ close() [1/2]

close_t FileMgr::close	(	const Fd	fd,
		const std::string &	caller )

override

Definition at line 402 of file FileMgr.cpp.

                                                       {
 
  // return codes:
  //   < 0 : error condition
  //     0 : actual close of one file
  //   > 0 : shared file, removed from list, no actual close, returns
  //         number of shared files still open.
 
  ON_VERBOSE
  verbose() << "close(" << fd << ")" << endmsg;
 
  close_t r = -1;
 
  auto itr = std::find_if( std::begin( m_files ), std::end( m_files ),
                           [&]( fileMap::const_reference i ) { return i.second->fd() == fd; } );
 
  if ( itr == std::end( m_files ) ) {
    error() << "unknown file descriptor \"" << fd << "\" when calling close()" << endmsg;
    return r;
  }
 
  IoTech tech = itr->second->tech();
 
  FileHdlr fh;
 
  if ( getHandler( tech, fh ).isFailure() ) { return r; }
 
  if ( !fh.b_close_fcn ) {
    error() << "no close(" << tech << ",Fd) function registered" << endmsg;
    return -1;
  }
 
  FileAttr* fa = itr->second;
 
  // find how many times this file is open
  auto fitr = m_files.equal_range( fa->name() );
  int  i = std::count_if( fitr.first, fitr.second, [&]( fileMap::const_reference f ) { return f.second->fd() == fd; } );
 
  ON_VERBOSE
  verbose() << "   ref count: " << i << endmsg;
 
  if ( i > 1 && fa->isShared() ) {
    // file open multiple times. don't do the actual close
    ON_DEBUG
    debug() << "closing file " << fa->name() << " opened " << i << " times with Fd " << fd << endmsg;
    m_files.erase( itr );
 
    r = i - 1;
 
  } else if ( i == 1 || ( i > 1 && !fa->isShared() ) ) {
    ON_DEBUG
    debug() << "closing " << *fa << endmsg;
 
    try {
      r = fh.b_close_fcn( fd );
    } catch ( const std::bad_function_call& err ) {
      error() << "when calling close handler for " << tech << " on file descriptor " << fd << " caught " << err.what()
              << endmsg;
      execAction( fa, caller, Io::CLOSE_ERR ).ignore();
      return -1;
    } catch ( ... ) {
      error() << "when calling close handler for " << tech << " on file descriptor " << fd
              << " caught an unknown exception." << endmsg;
      execAction( fa, caller, Io::CLOSE_ERR ).ignore();
      return -1;
    }
 
    if ( r < 0 ) {
      warning() << "close of file with FD \"" << fd << "\", name: \"" << fa->name() << "\", tech: \"" << tech
                << "\" failed" << endmsg;
 
      execAction( fa, caller, Io::CLOSE_ERR ).ignore();
 
      return r;
    }
 
    m_files.erase( itr );
 
  } else if ( i <= 0 ) {
    // this should never happen!
    error() << "ref count < 0 when closing " << fa << ". This should never happen" << endmsg;
    return -1;
  }
 
  fa->fd( -1 );
  fa->flags( INVALID );
  fa->isOpen( false );
  fa->fptr( 0 );
  m_oldFiles.push_back( fa );
 
  // exec all callbacks
  if ( execAction( fa, caller, Io::CLOSE ).isFailure() ) {
    warning() << "at least one close callback action failed" << endmsg;
  }
 
  return r;
}

◆ close() [2/2]

close_t FileMgr::close	(	void *	vp,
		const std::string &	caller )

override

Definition at line 501 of file FileMgr.cpp.

                                                          {
 
  // return codes:
  //   < 0 : error condition
  //     0 : actual close of one file
  //   > 0 : shared file, removed from list, no actual close, returns
  //         number of shared files still open.
 
  ON_VERBOSE
  verbose() << "close(" << vp << ")" << endmsg;
 
  close_t r = -1;
 
  auto itr = std::find_if( std::begin( m_files ), std::end( m_files ),
                           [&]( fileMap::const_reference i ) { return i.second->fptr() == vp; } );
 
  if ( itr == m_files.end() ) {
    error() << "unknown file ptr \"" << vp << "\" when calling close()" << endmsg;
    return r;
  }
 
  IoTech tech = itr->second->tech();
 
  FileHdlr fh;
 
  if ( getHandler( tech, fh ).isFailure() ) { return r; }
  if ( !fh.b_closeP_fcn ) {
    error() << "no close(" << tech << ",void*) function registered" << endmsg;
    return -1;
  }
 
  FileAttr* fa = itr->second;
 
  // find how many times this file is open
  pair<fileMap::const_iterator, fileMap::const_iterator> fitr = m_files.equal_range( fa->name() );
 
  int i =
      std::count_if( fitr.first, fitr.second, [&]( fileMap::const_reference f ) { return f.second->fptr() == vp; } );
 
  ON_VERBOSE
  verbose() << "   ref count: " << i << endmsg;
 
  if ( i > 1 && fa->isShared() ) {
    // file open multiple times in shared access. don't do the actual close
    ON_DEBUG
    debug() << "closing file " << fa->name() << " opened " << i << " times with fptr " << vp << endmsg;
    m_files.erase( itr );
 
    r = i - 1;
 
  } else if ( i == 1 || ( i > 1 && !fa->isShared() ) ) {
    ON_DEBUG
    debug() << "closing: " << *fa << endmsg;
 
    try {
      r = fh.b_closeP_fcn( vp );
    } catch ( const std::bad_function_call& err ) {
      error() << "when calling close handler for " << tech << " on file " << fa->name() << " caught " << err.what()
              << endmsg;
      execAction( fa, caller, CLOSE_ERR ).ignore();
      return -1;
    } catch ( ... ) {
      error() << "when calling close handler for " << tech << " on file " << fa->name()
              << " caught an unknown exception." << endmsg;
      execAction( fa, caller, CLOSE_ERR ).ignore();
      return -1;
    }
 
    if ( r < 0 ) {
      warning() << "close of file with ptr \"" << vp << "\", name: \"" << fa->name() << "\", tech: \"" << tech
                << "\" failed" << endmsg;
 
      return r;
    }
 
    m_files.erase( itr );
 
  } else {
    // this should never happen!
    error() << "ref count: " << i << " < 0 when closing " << fa << ". This should never happen" << endmsg;
    return -1;
  }
 
  fa->fd( -1 );
  fa->flags( INVALID );
  fa->isOpen( false );
  fa->fptr( 0 );
  m_oldFiles.push_back( fa );
 
  // exec all callbacks
  if ( execAction( fa, caller, CLOSE ).isFailure() ) {
    warning() << "at least one close callback action failed" << endmsg;
  }
 
  return r;
}

◆ deregHandler()

StatusCode FileMgr::deregHandler ( const IoTech & tech )

override

Definition at line 220 of file FileMgr.cpp.

                                                     {
  FileHdlr hdlr;
 
  auto itr = m_handlers.find( tech );
  if ( itr == m_handlers.end() ) {
    error() << "Can't de-register tech " << tech << " as it hasn't been registered!" << endmsg;
    return StatusCode::FAILURE;
  }
 
  m_handlers.erase( itr );
  return StatusCode::SUCCESS;
}

◆ execAction()

StatusCode FileMgr::execAction	(	Io::FileAttr *	fa,
		const std::string &	caller,
		const Io::Action &	a ) const

private

Definition at line 1097 of file FileMgr.cpp.

                                                                                                 {
 
  Io::IoTech tech = fa->tech();
 
  StatusCode s1, s2;
 
  auto itr = m_actions.find( Io::UNKNOWN );
 
  if ( itr != m_actions.end() && !itr->second.empty() ) { s1 = execActs( fa, caller, a, itr->second ); }
 
  itr = m_actions.find( tech );
  if ( itr != m_actions.end() && !itr->second.empty() ) { s2 = execActs( fa, caller, a, itr->second ); }
 
  return ( s1.isFailure() || s2.isFailure() ) ? StatusCode::FAILURE : StatusCode::SUCCESS;
}

◆ execActs()

StatusCode FileMgr::execActs	(	Io::FileAttr *	fa,
		const std::string &	caller,
		const Io::Action &	a,
		const actionMap &	m ) const

private

Definition at line 1115 of file FileMgr.cpp.

                                                         {
 
  auto mitr = m.find( a );
  if ( mitr == m.end() || mitr->second.empty() ) return StatusCode::SUCCESS;
 
  ON_DEBUG
  debug() << "executing " << mitr->second.size() << " " << a << " actions on " << *fa << " from " << caller << endmsg;
 
  bool fail( false );
 
  auto it2 = m_supMap.find( fa->name() );
  if ( it2 != m_supMap.end() ) {
    if ( it2->second[a] || it2->second[Io::INVALID_ACTION] ) {
      ON_DEBUG
      debug() << "     --> suppressing callback action for " << a << endmsg;
      return StatusCode::SUCCESS;
    }
  }
 
  for ( const auto& itr : mitr->second ) {
 
    ON_DEBUG
    debug() << "executing " << itr.second << endmsg;
 
    if ( ( ( ( itr.first ) )( fa, caller ) ).isFailure() ) {
      warning() << "execution of " << itr.second << " on " << *fa << " failed during " << a << " action" << endmsg;
      fail = true;
    }
  }
 
  return fail ? StatusCode::FAILURE : StatusCode::SUCCESS;
}

◆ fd() [1/2]

Io::Fd FileMgr::fd ( const std::string & fname ) const

override

Definition at line 949 of file FileMgr.cpp.

                                               {
 
  auto fitr = m_files.equal_range( fname );
  auto itr = std::find_if( fitr.first, fitr.second, []( fileMap::const_reference f ) { return f.second->fd() != -1; } );
  return itr != fitr.second ? itr->second->fd() : -1;
}

◆ fd() [2/2]

Io::Fd FileMgr::fd ( void * fptr ) const

override

Definition at line 958 of file FileMgr.cpp.

                                   {
 
  auto itr = std::find_if( m_files.begin(), m_files.end(),
                           [&]( fileMap::const_reference f ) { return f.second->fptr() == fptr; } );
  return itr != m_files.end() ? itr->second->fd() : -1;
}

◆ finalize()

StatusCode FileMgr::finalize ( )

override

Definition at line 125 of file FileMgr.cpp.

                             {
  ON_VERBOSE
  verbose() << "FileMgr::finalize()" << endmsg;
 
  if ( m_printSummary || msgLevel( MSG::DEBUG ) ) {
    listHandlers();
    listFiles();
    listActions();
    listSuppression();
  }
 
  if ( !m_files.empty() ) {
    auto& log = warning();
    log << "At finalize, the following files remained open:\n";
    for ( const auto& itr : m_files ) log << *( itr.second ) << '\n';
    log << endmsg;
  }
 
  if ( m_logfile.value() != "" ) {
    std::ofstream ofs;
    ofs.open( m_logfile.value().c_str() );
    if ( !ofs ) {
      error() << "Unable to open output file \"" << m_logfile.value() << "\" for writing" << endmsg;
    } else {
      ON_DEBUG
      debug() << "Saving log to \"" << m_logfile.value() << "\"" << endmsg;
      for ( const auto& itr : m_files ) {
        ofs << itr.second->name() << "  " << itr.second->tech() << "  " << itr.second->desc() << "  "
            << itr.second->iflags() << '\n';
      }
 
      set<FileAttr> fs;
      for ( const auto& it2 : m_oldFiles ) fs.insert( *it2 );
      for ( const auto& it3 : fs ) {
        ofs << it3.name() << "  " << it3.tech() << "  " << it3.desc() << "  " << it3.iflags()
            << ( it3.isShared() ? "  SHARED" : "" ) << '\n';
      }
      ofs.close();
    }
  }
 
  // cleanup FileAttrs
  m_attr.clear();
 
  m_rfh.reset();
  m_pfh.reset();
 
  StatusCode status = Service::finalize();
 
  ON_DEBUG
  if ( status.isSuccess() ) debug() << "Service finalised successfully" << endmsg;
 
  return status;
}

◆ fname() [1/2]

const std::string & FileMgr::fname ( const Io::Fd & fd ) const

override

Definition at line 931 of file FileMgr.cpp.

                                                      {
 
  auto itr = std::find_if( std::begin( m_files ), std::end( m_files ),
                           [&]( fileMap::const_reference f ) { return f.second->fd() == fd; } );
  return ( itr != std::end( m_files ) ) ? itr->second->name() : s_empty;
}

◆ fname() [2/2]

const std::string & FileMgr::fname ( void * vp ) const

override

Definition at line 940 of file FileMgr.cpp.

                                                {
 
  auto itr = std::find_if( m_files.begin(), m_files.end(),
                           [&]( fileMap::const_reference f ) { return f.second->fptr() == vp; } );
  return itr != m_files.end() ? itr->second->name() : s_empty;
}

◆ fptr() [1/2]

void * FileMgr::fptr ( const Io::Fd & fd ) const

override

Definition at line 976 of file FileMgr.cpp.

                                          {
 
  auto itr = std::find_if( m_files.begin(), m_files.end(),
                           [&]( fileMap::const_reference f ) { return f.second->fd() == fd; } );
  return itr != m_files.end() ? itr->second->fptr() : nullptr;
}

◆ fptr() [2/2]

void * FileMgr::fptr ( const std::string & fname ) const

override

Definition at line 967 of file FileMgr.cpp.

                                                  {
  auto fitr = m_files.equal_range( fname );
  auto itr =
      std::find_if( fitr.first, fitr.second, []( fileMap::const_reference f ) -> bool { return f.second->fptr(); } );
  return itr != fitr.second ? itr->second->fptr() : nullptr;
}

◆ getFd() [1/3]

int FileMgr::getFd	(	const Io::IoTech &	tech,
		const Io::IoFlags &	flags,
		std::vector< Io::Fd > &	fd ) const

override

Definition at line 919 of file FileMgr.cpp.

                                                                                   {
 
  fd.clear();
  transform_if( m_descriptors.begin(), m_descriptors.end(), std::back_inserter( fd ), select1st,
                [&]( const std::pair<Fd, FileAttr*>& d ) {
                  return ( d.second->tech() == tech || tech == UNKNOWN ) && ( d.second->flags() == flags );
                } );
  return fd.size();
}

◆ getFd() [2/3]

int FileMgr::getFd	(	const Io::IoTech &	tech,
		std::vector< Io::Fd > &	fd ) const

override

Definition at line 904 of file FileMgr.cpp.

                                                             {
 
  if ( tech == UNKNOWN ) return getFd( fd );
 
  fd.clear();
  transform_if( std::begin( m_descriptors ), std::end( m_descriptors ), std::back_inserter( fd ), select1st,
                [&]( const std::pair<Fd, FileAttr*>& d ) { return d.second->tech() == tech; } );
 
  return fd.size();
}

◆ getFd() [3/3]

int FileMgr::getFd ( std::vector< Fd > & fd ) const

override

Definition at line 893 of file FileMgr.cpp.

                                         {
 
  std::transform( std::begin( m_descriptors ), std::end( m_descriptors ), std::back_inserter( fd ), select1st );
  return m_descriptors.size();
}

◆ getFileAttr() [1/3]

StatusCode FileMgr::getFileAttr	(	const Fd	fd,
		const FileAttr *&	fa ) const

override

Definition at line 738 of file FileMgr.cpp.

                                                                        {
 
  auto i = std::find_if( std::begin( m_files ), std::end( m_files ),
                         [&]( fileMap::const_reference f ) { return f.second->fd() == fd; } );
  if ( i != std::end( m_files ) ) {
    fa = i->second;
    return StatusCode::SUCCESS;
  }
 
  auto j = std::find_if( std::begin( m_oldFiles ), std::end( m_oldFiles ),
                         [&]( const FileAttr* f ) { return f->fd() == fd; } );
  if ( j != std::end( m_oldFiles ) ) {
    fa = *j;
    return StatusCode::SUCCESS;
  }
 
  return StatusCode::FAILURE;
}

◆ getFileAttr() [2/3]

int FileMgr::getFileAttr	(	const std::string &	fname,
		std::vector< const FileAttr * > &	fa ) const

override

Definition at line 723 of file FileMgr.cpp.

                                                                                    {
 
  fa.clear();
 
  auto fitr = m_files.equal_range( fname );
  std::transform( fitr.first, fitr.second, std::back_inserter( fa ), select2nd );
 
  std::copy_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( fa ),
                [&]( const FileAttr* f ) { return f->name() == fname; } );
 
  return fa.size();
}

◆ getFileAttr() [3/3]

StatusCode FileMgr::getFileAttr	(	void *	vp,
		const FileAttr *&	fa ) const

override

Definition at line 759 of file FileMgr.cpp.

                                                                     {
 
  auto i = std::find_if( std::begin( m_files ), std::end( m_files ),
                         [&]( fileMap::const_reference f ) { return f.second->fptr() == vp; } );
  if ( i != std::end( m_files ) ) {
    fa = i->second;
    return StatusCode::SUCCESS;
  }
 
  auto j = std::find_if( std::begin( m_oldFiles ), std::end( m_oldFiles ),
                         [&]( const FileAttr* f ) { return f->fptr() == vp; } );
  if ( j != std::end( m_oldFiles ) ) {
    fa = *j;
    return StatusCode::SUCCESS;
  }
 
  return StatusCode::FAILURE;
}

◆ getFiles() [1/6]

int FileMgr::getFiles	(	const Io::IoTech &	tech,
		const Io::IoFlags &	flags,
		std::vector< const Io::FileAttr * > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 870 of file FileMgr.cpp.

                                                                                                                 {
 
  files.clear();
 
  auto matches_tech_and_flags = [&]( const FileAttr* f ) {
    return ( f->tech() == tech || tech == UNKNOWN ) && f->flags() == flags;
  };
 
  transform_copy_if( std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), select2nd,
                     matches_tech_and_flags );
  if ( !op ) {
    std::copy_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ),
                  matches_tech_and_flags );
  }
 
  return files.size();
}

◆ getFiles() [2/6]

int FileMgr::getFiles	(	const Io::IoTech &	tech,
		const Io::IoFlags &	flags,
		std::vector< std::string > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 847 of file FileMgr.cpp.

                                                                                                      {
 
  files.clear();
 
  auto not_in_files = [&]( const std::string& n ) {
    return std::none_of( std::begin( files ), std::end( files ), [&]( const std::string& f ) { return f == n; } );
  };
  auto matches_tech_and_flags = [&]( const FileAttr* f ) {
    return ( f->tech() == tech || tech == UNKNOWN ) && f->flags() == flags;
  };
 
  transform_if(
      std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), to_name,
      [&]( fileMap::const_reference f ) { return matches_tech_and_flags( f.second ) && not_in_files( f.first ); } );
  if ( !op ) {
    transform_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ), to_name,
                  [&]( const FileAttr* f ) { return matches_tech_and_flags( f ) && not_in_files( f->name() ); } );
  }
 
  return files.size();
}

◆ getFiles() [3/6]

int FileMgr::getFiles	(	const Io::IoTech &	tech,
		std::vector< const Io::FileAttr * > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 830 of file FileMgr.cpp.

                                                                                           {
 
  if ( tech == UNKNOWN ) return getFiles( files, op );
 
  auto matches_tech = [&]( const FileAttr* f ) { return f->tech() == tech; };
 
  files.clear();
  transform_copy_if( std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), select2nd, matches_tech );
  if ( !op ) {
    std::copy_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ), matches_tech );
  }
 
  return files.size();
}

◆ getFiles() [4/6]

int FileMgr::getFiles	(	const Io::IoTech &	tech,
		std::vector< std::string > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 806 of file FileMgr.cpp.

                                                                                {
 
  if ( tech == UNKNOWN ) return getFiles( files, op );
 
  files.clear();
  transform_if( std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), to_name,
                [&]( fileMap::const_reference f ) {
                  return f.second->tech() == tech &&
                         std::none_of( std::begin( files ), std::end( files ),
                                       [&]( const std::string& j ) { return j == f.first; } );
                } );
 
  if ( !op ) {
    transform_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ), to_name,
                  [&]( const FileAttr* f ) {
                    return f->tech() == tech && std::none_of( std::begin( files ), std::end( files ),
                                                              [&]( const std::string& j ) { return j == f->name(); } );
                  } );
  }
  return files.size();
}

◆ getFiles() [5/6]

int FileMgr::getFiles	(	std::vector< const Io::FileAttr * > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 796 of file FileMgr.cpp.

                                                                       {
 
  files.clear();
  std::transform( std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), select2nd );
  if ( !op ) { std::copy( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ) ); }
  return files.size();
}

◆ getFiles() [6/6]

int FileMgr::getFiles	(	std::vector< std::string > &	files,
		bool	onlyOpen = true ) const

override

Definition at line 780 of file FileMgr.cpp.

                                                                  {
 
  files.clear();
  auto not_in_files = [&]( const std::string& i ) {
    return std::none_of( std::begin( files ), std::end( files ), [&]( const std::string& j ) { return j == i; } );
  };
  transform_copy_if( std::begin( m_files ), std::end( m_files ), std::back_inserter( files ), to_name, not_in_files );
  if ( !op ) {
    transform_copy_if( std::begin( m_oldFiles ), std::end( m_oldFiles ), std::back_inserter( files ), to_name,
                       not_in_files );
  }
  return files.size();
}

◆ getHandler() [1/2]

StatusCode FileMgr::getHandler	(	const IoTech &	tech,
		Io::FileHdlr &	hdlr ) const

override

Definition at line 1005 of file FileMgr.cpp.

                                                                             {
 
  auto itr = m_handlers.find( tech );
  if ( itr == m_handlers.end() ) {
    error() << "no handler for tech " << tech << " registered" << endmsg;
    return StatusCode::FAILURE;
  }
  hdlr = itr->second;
  return StatusCode::SUCCESS;
}

◆ getHandler() [2/2]

StatusCode FileMgr::getHandler	(	const std::string &	fname,
		Io::FileHdlr &	hdlr ) const

override

Definition at line 1018 of file FileMgr.cpp.

                                                                               {
 
  auto fitr = m_files.equal_range( fname );
  if ( fitr.first == fitr.second ) {
    error() << "no file \"" << fname << "\" registered. Cannot determine tech" << endmsg;
    return StatusCode::FAILURE;
  }
 
  auto   itr  = fitr.first;
  IoTech tech = itr->second->tech();
 
  ++itr;
  while ( itr != fitr.second ) {
    if ( itr->second->tech() != tech ) {
      error() << "multiple technologies registered for file \"" << fname << "\". Cannot determine handler" << endmsg;
      return StatusCode::FAILURE;
    }
    ++itr;
  }
 
  return getHandler( tech, hdlr );
}

◆ getLastError()

int FileMgr::getLastError ( std::string & err ) const

override

Definition at line 997 of file FileMgr.cpp.

                                                {
 
  err = m_lastErrS;
  return m_lastErr;
}

◆ handle()

void FileMgr::handle ( const Incident & )

override

Definition at line 182 of file FileMgr.cpp.

182{}

◆ hasHandler()

StatusCode FileMgr::hasHandler ( const IoTech & tech ) const

override

Definition at line 234 of file FileMgr.cpp.

                                                         {
 
  auto itr = m_handlers.find( tech );
  return ( itr != m_handlers.end() ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

◆ initialize()

StatusCode FileMgr::initialize ( )

override

Definition at line 71 of file FileMgr.cpp.

                               {
  StatusCode status = Service::initialize();
 
  if ( status.isFailure() ) {
 
    ON_DEBUG
    debug() << "Failed to initialize the base class (Service)" << endmsg;
    return status;
  }
 
  ON_VERBOSE
  verbose() << "Initializing FileMgr" << endmsg;
 
  if ( m_loadRootHandler.value() ) {
 
    // setup file handler for ROOT
 
    msgSvc()->setOutputLevel( "RootFileHandler", m_outputLevel.value() );
    m_rfh.emplace( msgSvc(), m_ssl_proxy, m_ssl_cert );
 
    auto&        rfh = m_rfh.value(); // used in the lambdas to avoid capturing 'this'
    Io::FileHdlr hdlr(
        Io::ROOT,
        [&rfh]( const std::string& n, const Io::IoFlags& f, const std::string& desc, Io::Fd& fd,
                void*& ptr ) -> Io::open_t { return rfh.openRootFile( n, f, desc, fd, ptr ); },
        [&rfh]( void* ptr ) -> Io::close_t { return rfh.closeRootFile( ptr ); },
        [&rfh]( void* ptr, const Io::IoFlags& f ) -> Io::reopen_t { return rfh.reopenRootFile( ptr, f ); } );
 
    if ( regHandler( hdlr ).isFailure() ) { error() << "unable to register ROOT file handler with FileMgr" << endmsg; }
  }
 
  if ( m_loadPosixHandler.value() ) {
 
    // setup file handler for POSIX
 
    msgSvc()->setOutputLevel( "POSIXFileHandler", m_outputLevel.value() );
    m_pfh.emplace( msgSvc() );
 
    auto&        pfh = m_pfh.value(); // used in the lambdas to avoid capturing 'this'
    Io::FileHdlr hdlp(
        Io::POSIX,
        [&pfh]( const std::string& n, const Io::IoFlags& f, const std::string& desc, Io::Fd& fd,
                void*& ptr ) -> Io::open_t { return pfh.openPOSIXFile( n, f, desc, fd, ptr ); },
        [&pfh]( Io::Fd fd ) -> Io::close_t { return pfh.closePOSIXFile( fd ); },
        [&pfh]( Io::Fd fd, const Io::IoFlags& f ) -> Io::reopen_t { return pfh.reopenPOSIXFile( fd, f ); } );
 
    if ( regHandler( hdlp ).isFailure() ) { error() << "unable to register ROOT file handler with FileMgr" << endmsg; }
  }
 
  return StatusCode::SUCCESS;
}

◆ isShareable()

bool FileMgr::isShareable	(	const std::string &	filename,
		const Io::IoFlags &	) const

private

◆ listActions()

void FileMgr::listActions ( ) const

virtual

Definition at line 1072 of file FileMgr.cpp.

                                {
 
  info() << "listing registered actions\n";
 
  for ( const auto& iit : m_actions ) {
    Io::IoTech       t = iit.first;
    const actionMap& m = iit.second;
 
    if ( !m.empty() ) {
      info() << " --- Tech: ";
      if ( t == Io::UNKNOWN ) {
        info() << "ALL ---\n";
      } else {
        info() << t << " ---\n";
      }
      for ( const auto& iia : m ) {
        for ( const auto& it2 : iia.second ) { info() << "   " << iia.first << "  " << it2.second << '\n'; }
      }
    }
  }
  info() << endmsg;
}

◆ listFiles()

void FileMgr::listFiles ( ) const

override

Definition at line 985 of file FileMgr.cpp.

                              {
 
  info() << "listing registered files [" << ( m_files.size() + m_oldFiles.size() ) << "]:\n";
 
  for ( auto& itr : m_files ) info() << itr.second << '\n';
  for ( auto& it2 : m_oldFiles ) info() << *it2 << '\n';
 
  info() << endmsg;
}

◆ listHandlers()

void FileMgr::listHandlers ( ) const

override

Definition at line 1043 of file FileMgr.cpp.

                                 {
 
  info() << "Listing registered handlers:\n";
 
  for ( const auto& itr : m_handlers ) info() << "    " << itr.first << '\n';
  info() << endmsg;
}

◆ listSuppression()

void FileMgr::listSuppression ( ) const

virtual

Definition at line 1170 of file FileMgr.cpp.

                                    {
  if ( m_supMap.empty() ) return;
 
  info() << "listing suppressed file actions\n";
 
  for ( const auto& sup : m_supMap ) {
    info() << "  " << sup.first;
    if ( sup.second[Io::INVALID_ACTION] ) {
      info() << " ALL\n";
    } else {
      for ( unsigned i = 0; i != sup.second.size(); ++i ) {
        if ( sup.second[i] ) info() << " " << (Io::Action)i;
      }
      info() << '\n';
    }
  }
  info() << endmsg;
}

◆ open() [1/4]

open_t FileMgr::open	(	const Io::IoTech &	tech,
		const std::string &	caller,
		const std::string &	fname,
		const Io::IoFlags &	flags,
		Io::Fd &	fd,
		const std::string &	desc = "",
		const bool	shared = false )

override

Definition at line 249 of file FileMgr.cpp.

                                                               {
 
  void* dummy( 0 );
  return open( tech, caller, fname, desc, flags, fd, dummy, sh );
}

◆ open() [2/4]

open_t FileMgr::open	(	const Io::IoTech &	tech,
		const std::string &	caller,
		const std::string &	fname,
		const Io::IoFlags &	flags,
		Io::Fd &	fd,
		void *&	ptr,
		const std::string &	desc = "",
		const bool	shared = false )

override

Definition at line 242 of file FileMgr.cpp.

                                                                           {
 
  return open( tech, caller, fname, desc, flags, fd, ptr, sh );
}

◆ open() [3/4]

open_t FileMgr::open	(	const Io::IoTech &	tech,
		const std::string &	caller,
		const std::string &	fname,
		const Io::IoFlags &	flags,
		void *&	ptr,
		const std::string &	desc = "",
		const bool	shared = false )

override

Definition at line 257 of file FileMgr.cpp.

                                                                   {
 
  Fd dummy( -1 );
  return open( tech, caller, fname, desc, flags, dummy, ptr, sh );
}

◆ open() [4/4]

open_t FileMgr::open	(	const IoTech &	tech,
		const std::string &	caller,
		const std::string &	fname,
		const std::string &	desc,
		const IoFlags &	flags,
		Fd &	fd,
		void *&	ptr,
		const bool	shared )

privatevirtual

Definition at line 266 of file FileMgr.cpp.

                                                                              {
 
  // return codes: ok == 0, warning > 0, error < 0
  //   0: ok
  //
  // WARNING:
  //   1: file already open with existing FileAttributes
  //   2: file already open with different FileAttributes
  //   3: file opened, but fd and ptr are both invalid
  //
  // ERRORS:
  //  -1: no handler for TECH
  //  -2: file already open with different tech
  //  -3: file asked to be opened in shared mode, but other open file
  //      exist that are marked unshared
  //  -4: error calling tech specific open function
 
  ON_VERBOSE
  verbose() << "open(" << tech << "," << caller << ",\"" << fname << "\",\"" << desc << "\"," << flags
            << ( shared ? ",shared" : ",unshared" ) << ")" << endmsg;
 
  open_t   r = -1;
  FileHdlr fh;
  if ( getHandler( tech, fh ).isFailure() ) return r;
 
  auto fitr = m_files.equal_range( fname );
 
  // make sure all files with same name have same tech
 
  auto itr =
      std::find_if( fitr.first, fitr.second, [&]( fileMap::const_reference i ) { return i.second->tech() != tech; } );
  if ( itr != fitr.second ) {
    error() << "when calling open on " << fname << " with tech " << tech << ", file already opened with different tech "
            << itr->second->tech() << endmsg;
    r = -1;
    return r;
  }
 
  // check for sharing
 
  if ( shared ) {
 
    bool shareable( true );
 
    for ( auto itr = fitr.first; itr != fitr.second; ++itr ) {
      FileAttr* fa = itr->second;
 
      if ( !fa->isShared() ) shareable = false;
 
      //      if ( shareable && accessMatch(fa->flags(),flags) )
      if ( shareable && fa->flags().match( flags, false ) ) {
 
        ON_DEBUG
        debug() << " found shared file: " << *fa << endmsg;
 
        fd  = fa->fd();
        ptr = fa->fptr();
        r   = 0;
      }
    }
 
    if ( !shareable ) {
      // at least one of the other files was not marked shared.
      fd  = -1;
      ptr = 0;
      r   = -1;
    }
  }
 
  if ( r != 0 ) {
 
    try {
      r = fh.b_open_fcn( fname, flags, desc, fd, ptr );
    } catch ( const std::bad_function_call& err ) {
      error() << "when calling open handler for " << tech << " on file " << fname << " caught " << err.what() << endmsg;
      return -4;
    } catch ( ... ) {
      error() << "when calling open handler for " << tech << " on file " << fname << " caught an unknown exception."
              << endmsg;
      return -4;
    }
 
    if ( r != 0 ) {
      warning() << "open of file \"" << fname << "\", tech: \"" << tech << "\", flags: \"" << flags
                << "\" requested by " << caller << " failed. return code: " << r << endmsg;
 
      FileAttr xfa( -1, fname, desc, tech, flags, 0, false );
      execAction( &xfa, caller, Io::OPEN_ERR ).ignore();
 
      return r;
    }
  }
 
  //@TODO/@FIXME: should this not be pushed into m_attr???
  // eg. m_attr.emplace_back( new FileAttr(fd,fname,desc,tech,flags,ptr,true,shared) );
  //     FileAttr* fa = m_attr.back().get();
  FileAttr* fa = new FileAttr( fd, fname, desc, tech, flags, ptr, true, shared );
 
  ON_DEBUG
  debug() << "opened file " << *fa << endmsg;
 
  if ( fd == -1 && ptr == 0 ) {
    warning() << "when opening " << *fa << " both File Descriptor"
              << " and File Ptr are invalid" << endmsg;
    r = 3;
  }
 
  for ( auto itr = fitr.first; itr != fitr.second; ++itr ) {
    if ( fa->flags() == Io::READ || shared ) {
      // ok
    } else if ( *fa == *( itr->second ) ) {
      warning() << "open call for file \"" << fname << "\" returned a pre-existing file with identical"
                << " FileAttributes: " << *fa << endmsg;
      r = 1;
    } else {
      warning() << "open call for file \"" << fname << "\" returned a pre-existing file with different"
                << " FileAttributes -\n"
                << "old: " << *( itr->second ) << '\n'
                << "new: " << *fa << endmsg;
      r = 2;
    }
  }
 
  m_files.emplace( fname, fa );
 
  // execute all our open callbacks
  if ( execAction( fa, caller, Io::OPEN ).isFailure() ) {
    warning() << "at least one open callback action failed" << endmsg;
  }
 
  return r;
}

◆ regAction() [1/2]

StatusCode FileMgr::regAction	(	Io::bfcn_action_t	bf,
		const Io::Action &	a,
		const Io::IoTech &	t,
		const std::string &	desc = "" )

override

Definition at line 1060 of file FileMgr.cpp.

                                                                                                          {
 
  ON_DEBUG
  debug() << "registering " << a << " action " << System::typeinfoName( bf.target_type() ) << " for tech " << t
          << endmsg;
 
  m_actions[t][a].emplace_back( bf, ( !d.empty() ) ? d : System::typeinfoName( bf.target_type() ) );
  return StatusCode::SUCCESS;
}

◆ regAction() [2/2]

StatusCode FileMgr::regAction	(	Io::bfcn_action_t	bf,
		const Io::Action &	a,
		const std::string &	desc = "" )

override

Definition at line 1053 of file FileMgr.cpp.

                                                                                       {
 
  return regAction( bf, a, Io::UNKNOWN, d );
}

◆ regHandler()

StatusCode FileMgr::regHandler ( FileHdlr fh )

override

Definition at line 186 of file FileMgr.cpp.

                                            {
 
  IoTech tech = fh.tech;
 
  if ( m_handlers.find( tech ) != m_handlers.end() ) {
    warning() << "Handler for IoTech " << tech << " already registered. Ignoring." << endmsg;
    return StatusCode::SUCCESS;
  }
 
  if ( !fh.b_open_fcn ) {
    error() << "open handler for tech " << tech << " is NULL" << endmsg;
    return StatusCode::FAILURE;
  }
 
  if ( !fh.b_close_fcn && !fh.b_closeP_fcn ) {
    error() << "no close handler for tech " << tech << " registered" << endmsg;
    return StatusCode::FAILURE;
  }
 
  if ( !fh.b_reopen_fcn && !fh.b_reopenP_fcn ) {
    error() << "no reopen handler for tech " << tech << " registered" << endmsg;
    return StatusCode::FAILURE;
  }
 
  ON_DEBUG
  debug() << "Successfully registered handler for tech \"" << tech << "\"" << endmsg;
 
  m_handlers[tech] = fh;
 
  return StatusCode::SUCCESS;
}

◆ reopen() [1/2]

reopen_t FileMgr::reopen	(	const Fd	fd,
		const IoFlags &	flags,
		const std::string &	caller )

override

Definition at line 600 of file FileMgr.cpp.

                                                                               {
 
  ON_VERBOSE
  verbose() << "reopen(" << fd << "," << flags << "," << caller << ")" << endmsg;
 
  reopen_t r = -1;
 
  auto itr = std::find_if( std::begin( m_files ), std::end( m_files ),
                           [&]( fileMap::const_reference f ) { return f.second->fd() == fd; } );
 
  if ( itr == m_files.end() ) {
    error() << "unregistered FD \"" << fd << "\" when calling reopen()" << endmsg;
    return r;
  }
 
  FileAttr* fa   = itr->second;
  IoTech    tech = fa->tech();
 
  FileHdlr fh;
 
  if ( getHandler( tech, fh ).isFailure() ) { return r; }
 
  fa->flags( flags );
 
  if ( !fh.b_reopen_fcn ) {
    error() << "no reopen(" << tech << ",Fd) function registered" << endmsg;
    return -1;
  }
 
  // FIXME: what does it mean to call reopen on a shared file?
 
  try {
    r = fh.b_reopen_fcn( fd, flags );
  } catch ( const std::bad_function_call& err ) {
    error() << "when calling reopen handler for " << tech << " on file descriptor " << fd << " with flags " << flags
            << " caught " << err.what() << endmsg;
    return -1;
  } catch ( ... ) {
    error() << "when calling reopen handler for " << tech << " on file descriptor " << fd << " with flags " << flags
            << " caught an unknown exception." << endmsg;
    return -1;
  }
 
  if ( r < 0 ) {
    warning() << "reopen of file with FD \"" << fd << "\", name: \"" << fa->name() << "\", tech: \"" << tech
              << "\", flags: \"" << flags << "\" failed" << endmsg;
 
    execAction( fa, caller, Io::REOPEN_ERR ).ignore();
 
    return r;
  }
 
  fa->isOpen( true );
  fa->flags( flags );
 
  // exec all callbacks
  if ( execAction( fa, caller, Io::REOPEN ).isFailure() ) {
    warning() << "at least one reopen callback action failed" << endmsg;
  }
 
  return r;
}

◆ reopen() [2/2]

reopen_t FileMgr::reopen	(	void *	vp,
		const IoFlags &	flags,
		const std::string &	caller )

override

Definition at line 665 of file FileMgr.cpp.

                                                                                  {
  ON_VERBOSE
  verbose() << "reopen(" << vp << "," << flags << "," << caller << ")" << endmsg;
 
  reopen_t r = -1;
 
  auto itr = std::find_if( std::begin( m_files ), std::end( m_files ),
                           [&]( fileMap::const_reference f ) { return f.second->fptr() == vp; } );
  if ( itr == m_files.end() ) {
    error() << "unregistered file ptr \"" << vp << "\" when calling reopen()" << endmsg;
    return r;
  }
 
  FileAttr* fa = itr->second;
  FileHdlr  fh;
  IoTech    tech = fa->tech();
 
  if ( getHandler( tech, fh ).isFailure() ) { return r; }
 
  if ( !fh.b_reopenP_fcn ) {
    error() << "no reopen(" << tech << ",void*) function registered" << endmsg;
    return -1;
  }
 
  try {
    r = fh.b_reopenP_fcn( vp, flags );
  } catch ( const std::bad_function_call& err ) {
    error() << "when calling reopen handler for " << tech << " on file " << fa->name() << " with flags " << flags
            << " caught " << err.what() << endmsg;
    return -1;
  } catch ( ... ) {
    error() << "when calling reopen handler for " << tech << " on file " << fa->name() << " with flags " << flags
            << " caught an unknown exception." << endmsg;
    return -1;
  }
 
  if ( r < 0 ) {
    warning() << "reopen of file with ptr \"" << vp << "\", name: \"" << fa->name() << "\", tech: \"" << tech
              << "\", flags: \"" << flags << "\" failed" << endmsg;
 
    execAction( fa, caller, Io::REOPEN_ERR ).ignore();
 
    return r;
  }
 
  fa->isOpen( true );
  fa->flags( flags );
 
  // exec all callbacks
  if ( execAction( fa, caller, Io::REOPEN ).isFailure() ) {
    warning() << "at least one reopen callback action failed" << endmsg;
  }
 
  return r;
}

◆ suppressAction() [1/2]

void FileMgr::suppressAction ( const std::string & f )

override

Definition at line 1162 of file FileMgr.cpp.

1162{ return suppressAction( f, Io::INVALID_ACTION ); }

FileMgr::suppressAction

void suppressAction(const std::string &) override

Definition FileMgr.cpp:1162

◆ suppressAction() [2/2]

void FileMgr::suppressAction	(	const std::string &	f,
		const Io::Action &	a )

override

Definition at line 1166 of file FileMgr.cpp.

1166{ m_supMap[f].set( a ); }

Member Data Documentation

◆ m_actions

std::map<IoTech, actionMap> FileMgr::m_actions

private

Definition at line 151 of file FileMgr.h.

◆ m_attr

std::vector<std::unique_ptr<FileAttr> > FileMgr::m_attr

private

Definition at line 147 of file FileMgr.h.

◆ m_descriptors

std::map<Fd, FileAttr*> FileMgr::m_descriptors

private

Definition at line 146 of file FileMgr.h.

◆ m_files

fileMap FileMgr::m_files

private

Definition at line 144 of file FileMgr.h.

◆ m_handlers

std::map<IoTech, FileHdlr> FileMgr::m_handlers

private

Definition at line 145 of file FileMgr.h.

◆ m_lastErr

int FileMgr::m_lastErr

private

Definition at line 156 of file FileMgr.h.

◆ m_lastErrS

std::string FileMgr::m_lastErrS

private

Definition at line 155 of file FileMgr.h.

◆ m_loadPosixHandler

Gaudi::Property<bool> FileMgr::m_loadPosixHandler { this, "LoadPOSIXHandler", true }

private

Definition at line 125 of file FileMgr.h.

125{ this, "LoadPOSIXHandler", true };

◆ m_loadRootHandler

Gaudi::Property<bool> FileMgr::m_loadRootHandler { this, "LoadROOTHandler", true }

private

Definition at line 124 of file FileMgr.h.

124{ this, "LoadROOTHandler", true };

◆ m_logfile

Gaudi::Property<std::string> FileMgr::m_logfile { this, "LogFile" }

private

Definition at line 122 of file FileMgr.h.

122{ this, "LogFile" };

◆ m_oldFiles

std::vector<FileAttr*> FileMgr::m_oldFiles

private

Definition at line 149 of file FileMgr.h.

◆ m_pfh

std::optional<POSIXFileHandler> FileMgr::m_pfh

private

Definition at line 159 of file FileMgr.h.

◆ m_printSummary

Gaudi::Property<bool> FileMgr::m_printSummary { this, "PrintSummary", false }

private

Definition at line 123 of file FileMgr.h.

123{ this, "PrintSummary", false };

◆ m_rfh

std::optional<RootFileHandler> FileMgr::m_rfh

private

Definition at line 158 of file FileMgr.h.

◆ m_ssl_cert

Gaudi::Property<std::string> FileMgr::m_ssl_cert { this, "TSSL_CertDir", "X509" }

private

Definition at line 128 of file FileMgr.h.

128{ this, "TSSL_CertDir", "X509" };

◆ m_ssl_proxy

Gaudi::Property<std::string> FileMgr::m_ssl_proxy { this, "TSSL_UserProxy", "X509" }

private

Definition at line 127 of file FileMgr.h.

127{ this, "TSSL_UserProxy", "X509" };

◆ m_supMap

std::map<std::string, Io::Action_bitmap> FileMgr::m_supMap

private

Definition at line 153 of file FileMgr.h.

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

GaudiSvc/src/FileMgr/FileMgr.h
GaudiSvc/src/FileMgr/FileMgr.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ actionMap

◆ bfcn_desc_t

◆ fileMap

Constructor & Destructor Documentation

◆ ~FileMgr()

Member Function Documentation

◆ accessMatch()

◆ close() [1/2]

◆ close() [2/2]

◆ deregHandler()

◆ execAction()

◆ execActs()

◆ fd() [1/2]

◆ fd() [2/2]

◆ finalize()

◆ fname() [1/2]

◆ fname() [2/2]

◆ fptr() [1/2]

◆ fptr() [2/2]

◆ getFd() [1/3]

◆ getFd() [2/3]

◆ getFd() [3/3]

◆ getFileAttr() [1/3]

◆ getFileAttr() [2/3]

◆ getFileAttr() [3/3]

◆ getFiles() [1/6]

◆ getFiles() [2/6]

◆ getFiles() [3/6]

◆ getFiles() [4/6]

◆ getFiles() [5/6]

◆ getFiles() [6/6]

◆ getHandler() [1/2]

◆ getHandler() [2/2]

◆ getLastError()

◆ handle()

◆ hasHandler()

◆ initialize()

◆ isShareable()

◆ listActions()

◆ listFiles()

◆ listHandlers()

◆ listSuppression()

◆ open() [1/4]

◆ open() [2/4]

◆ open() [3/4]

◆ open() [4/4]

◆ regAction() [1/2]

◆ regAction() [2/2]

◆ regHandler()

◆ reopen() [1/2]

◆ reopen() [2/2]

◆ suppressAction() [1/2]

◆ suppressAction() [2/2]

Member Data Documentation

◆ m_actions

◆ m_attr

◆ m_descriptors

◆ m_files

◆ m_handlers

◆ m_lastErr

◆ m_lastErrS

◆ m_loadPosixHandler

◆ m_loadRootHandler

◆ m_logfile

◆ m_oldFiles

◆ m_pfh

◆ m_printSummary

◆ m_rfh

◆ m_ssl_cert

◆ m_ssl_proxy

◆ m_supMap