Base class for conditions containers for which keys are ranges in both Run+LBN and timestamp. More...

#include <CondCont.h>

Inheritance diagram for CondContMixedBase:

Collaboration diagram for CondContMixedBase:

Public Types
enum class	KeyType { SINGLE , TIMESTAMP , RUNLBN , MIXED }
	Type of key used for this container. More...
typedef void	Payload
	Payload type held by this class.
typedef uint64_t	key_type
	Type used to store an IOV time internally.

Public Member Functions
virtual void	list (std::ostream &ost) const override final
	Dump the container contents for debugging.
virtual size_t	entries () const override final
	Return the number of conditions objects in the container.
virtual std::vector< EventIDRange >	ranges () const override final
	Return all IOV validity ranges defined in this container.
virtual StatusCode	typelessInsert (const EventIDRange &r, void *obj, const EventContext &ctx) override final
	Insert a new conditions object.
virtual bool	valid (const EventIDBase &t) const override final
	Test to see if a given IOV time is mapped in the container.
virtual bool	range (const EventIDBase &t, EventIDRange &r) const override final
	Return the mapped validity range for an IOV time.
virtual StatusCode	erase (const EventIDBase &t, const EventContext &ctx) override final
	Erase the first element not less than `t`.
virtual StatusCode	extendLastRange (const EventIDRange &newRange, const EventContext &ctx) override final
	Extend the range of the last IOV.
CLID	clid () const
	Return the CLID of the most-derived `CondCont`.
KeyType	keyType () const
	Return the key type for this container.
const DataObjID &	id () const
	Return CLID/key corresponding to this container.
SG::DataProxy *	proxy ()
	Return the associated `DataProxy`, if any.
const SG::DataProxy *	proxy () const
	Return the associated `DataProxy`, if any.
void	setProxy (SG::DataProxy *)
	Set the associated `DataProxy`.
void	print () const
	Dump the container to cout.
virtual size_t	trim (const std::vector< key_type > &runLbnKeys, const std::vector< key_type > &TSKeys)
	Remove unused entries from the front of the list.
void	clear ()
	Remove all entries in the container.
void	quiescent (const EventContext &ctx)
	Mark that this thread is no longer accessing data from this container.
size_t	nInserts () const
	Return the number times an item was inserted into the map.
size_t	maxSize () const
	Return the maximum size of the map.
void	addDep (CondContBase *dep)
	Declare another conditions container that depends on this one.
std::vector< CondContBase * >	getDeps ()
	Return the list of conditions containers that depend on this one.

Static Public Member Functions
static key_type	keyFromRunLBN (const EventIDBase &b)
	Make a run+lbn key from an EventIDBase.
static key_type	keyFromTimestamp (const EventIDBase &b)
	Make a timestamp key from an EventIDBase.
static void setCleanerSvcName	ATLAS_NOT_THREAD_SAFE (const std::string &name)
	Allow overriding the name of the global conditions cleaner service (for testing purposes).

Protected Types
typedef CxxUtils::ConcurrentRangeMap< RangeKey, key_type, void, Compare, Athena::RCUUpdater >	CondContSet
typedef CondContSet::Updater_t	Updater_t
typedef CondContSet::delete_function	delete_function

Protected Member Functions
	CondContMixedBase (Athena::IRCUSvc &rcusvc, CLID clid, const DataObjID &id, SG::DataProxy *proxy, std::shared_ptr< CondContSet::IPayloadDeleter > payloadDeleter, size_t capacity)
	Internal constructor.
StatusCode	insertMixed (const EventIDRange &r, CondContBase::CondContSet::payload_unique_ptr t, const EventContext &ctx)
	Insert a new conditions object.
const void *	findMixed (const EventIDBase &t, EventIDRange const **r) const
	Internal lookup function.
delete_function *	payloadDelfcn () const
	Return the payload deletion function for this container.
StatusCode	insertBase (const EventIDRange &r, CondContSet::payload_unique_ptr t, const EventContext &ctx)
	Insert a new conditions object.
StatusCode	eraseBase (const EventIDBase &t, const EventContext &ctx)
	Erase the first element not less than `t`.
StatusCode	extendLastRangeBase (const EventIDRange &newRange, const EventContext &ctx)
	Extend the range of the last IOV.
const void *	findBase (const EventIDBase &t, EventIDRange const **r) const
	Internal lookup function.
const void *	cast (CLID clid, const void *ptr) const
	Do pointer conversion for the payload type.
virtual const void *	doCast (CLID clid, const void *ptr) const =0
	Do pointer conversion for the payload type.
template<class FUNC>
void	forEach (const FUNC &func) const
	Call `func` on each entry in the container.
StatusCode	inserted (const EventContext &ctx)
	Tell the cleaner that a new object was added to the container.
void	insertError (CLID usedCLID) const
	Helper to report an error due to using a base class for insertion.
delete_function *	delfcn () const
	Return the deletion function for this container.
std::string	title () const
	Description of this container to use for MsgStream.

Private Types
using	DepSet = CxxUtils::ConcurrentPtrSet<CondContBase, CxxUtils::SimpleUpdater>
	Other conditions dependencies that depend on this one, as inferred by addDependency calls.

Private Attributes
Athena::IRCUSvc &	m_rcusvc
	Need to remember the RCU svc here in order to pass it to the TS maps.
std::shared_ptr< CondContSet::IPayloadDeleter >	m_payloadDeleter
	Deletion object for actual payload objects.
std::mutex	m_mutex
	Mutex for insertions.
std::atomic< KeyType >	m_keyType
	Key type of this container.
CLID	m_clid
	CLID of the most-derived `CondCont`.
DataObjID	m_id
	CLID+key for this container.
SG::DataProxy *	m_proxy
	Associated `DataProxy`.
CondContSet	m_condSet
	Set of mapped objects.
ServiceHandle< Athena::IConditionsCleanerSvc >	m_cleanerSvc
	Handle to the cleaner service.
DepSet	m_deps

Static Private Attributes
static std::string s_cleanerSvcName	ATLAS_THREAD_SAFE
	Name of the global conditions cleaner service.

Detailed Description

Base class for conditions containers for which keys are ranges in both Run+LBN and timestamp.

Definition at line 1030 of file CondCont.h.

Member Typedef Documentation

◆ CondContSet

typedef CxxUtils::ConcurrentRangeMap<RangeKey, key_type, void, Compare, Athena::RCUUpdater> CondContBase::CondContSet

protectedinherited

Definition at line 517 of file CondCont.h.

◆ delete_function

typedef CondContSet::delete_function CondContBase::delete_function

protectedinherited

Definition at line 520 of file CondCont.h.

◆ DepSet

using CondContBase::DepSet = CxxUtils::ConcurrentPtrSet<CondContBase, CxxUtils::SimpleUpdater>

privateinherited

Other conditions dependencies that depend on this one, as inferred by addDependency calls.

There should only be a few of them.

Definition at line 682 of file CondCont.h.

◆ key_type

typedef uint64_t CondContBase::key_type

inherited

Type used to store an IOV time internally.

For efficiency, we pack two 32-bit words into a 64-bit word Can be either run+lbn or a timestamp.

Definition at line 204 of file CondCont.h.

◆ Payload

typedef void CondContBase::Payload

inherited

Payload type held by this class.

Need to define this here for cast() to work properly.

Definition at line 198 of file CondCont.h.

◆ Updater_t

typedef CondContSet::Updater_t CondContBase::Updater_t

protectedinherited

Definition at line 519 of file CondCont.h.

Member Enumeration Documentation

◆ KeyType

enum class CondContBase::KeyType

stronginherited

Type of key used for this container.

Enumerator
SINGLE	Either TIMESTAMP or RUNLBN, but nothing's been put in the container yet, so we don't know which one.
TIMESTAMP	Container uses timestamp keys.
RUNLBN	Container uses run+lbn keys.
MIXED	Mixed Run+lbn / timestamp container.

Definition at line 179 of file CondCont.h.

  {
    SINGLE,
    TIMESTAMP,
    RUNLBN,
    MIXED,
  };

Constructor & Destructor Documentation

◆ CondContMixedBase()

CondContMixedBase::CondContMixedBase	(	Athena::IRCUSvc &	rcusvc,
		CLID	clid,
		const DataObjID &	id,
		SG::DataProxy *	proxy,
		std::shared_ptr< CondContSet::IPayloadDeleter >	payloadDeleter,
		size_t	capacity )

protected

Internal constructor.

Parameters

rcusvc	RCU service instance.
CLID	of the most-derived `CondCont`.
id	CLID+key for this object.
proxy	`DataProxy` for this object.
payloadDeleter	Object for deleting actual payload objects.
capacity	Initial capacity of the container.

Definition at line 900 of file CondCont.cxx.

  : CondContBase (rcusvc, KeyType::MIXED, clid, id, proxy,
                  std::make_shared<Athena::CondObjDeleter<CondContSet> > (rcusvc),
                  capacity),
    m_rcusvc (rcusvc),
    m_payloadDeleter (std::move(payloadDeleter))
{
}

Member Function Documentation

◆ addDep()

void CondContBase::addDep ( CondContBase * dep )

inherited

Declare another conditions container that depends on this one.

Parameters

dep	Conditions container that depends on this one.

Definition at line 695 of file CondCont.cxx.

{
  m_deps.insert (dep);
}

◆ ATLAS_NOT_THREAD_SAFE()

void setCleanerSvcName CondContBase::ATLAS_NOT_THREAD_SAFE ( const std::string & name )

staticinherited

Allow overriding the name of the global conditions cleaner service (for testing purposes).

Parameters

name	The name of the global conditions cleaner service.

◆ cast()

const void * CondContBase::cast	(	CLID	clid,
		const void *	ptr ) const

protectedinherited

Do pointer conversion for the payload type.

Parameters

clid	CLID for the desired pointer type.
ptr	Pointer of type `T*`.

Converts ptr from T* to a pointer to the type given by clid. Returns nullptr if the conversion is not possible.

◆ clear()

void CondContBase::clear ( )

inherited

Remove all entries in the container.

Mostly for testing — should not normally be used.

Definition at line 360 of file CondCont.cxx.

{
  m_condSet.clear();
}

◆ clid()

CLID CondContBase::clid ( ) const

inherited

Return the CLID of the most-derived CondCont.

◆ delfcn()

CondContBase::delete_function * CondContBase::delfcn ( ) const

protectedinherited

Return the deletion function for this container.

Definition at line 739 of file CondCont.cxx.

{
  return m_condSet.deleter().delfcn();
}

◆ doCast()

virtual const void * CondContBase::doCast	(	CLID	clid,
		const void *	ptr ) const

protectedpure virtualinherited

Do pointer conversion for the payload type.

Parameters

clid	CLID for the desired pointer type.
ptr	Pointer of type `T*`.

Converts ptr from T* to a pointer to the type given by clid. Returns nullptr if the conversion is not possible.

This is a virtual function that calls cast from the most-derived class of the hierarchy.

◆ entries()

size_t CondContMixedBase::entries ( ) const

finaloverridevirtual

Return the number of conditions objects in the container.

Reimplemented from CondContBase.

Definition at line 942 of file CondCont.cxx.

{
  size_t nent = 0;
  forEach ([&] (const CondContSet::value_type& ent) {
    const CondContSet* tsmap =
      reinterpret_cast<const CondContSet*> (ent.second);
    nent += tsmap->size();
  });
  return nent;
}

◆ erase()

StatusCode CondContMixedBase::erase	(	const EventIDBase &	t,
		const EventContext &	ctx )

finaloverridevirtual

Erase the first element not less than t.

Parameters

IOV	time of element to erase.
ctx	Event context for the current thread.

This is not implemented for mixed containers.

Implements CondContBase.

Definition at line 1032 of file CondCont.cxx.

{
  MsgStream msg (Athena::getMessageSvc(), title());
  msg << MSG::ERROR << "CondContMixedBase::erase: "
      << "erase() is not implemented for mixed containers."
      << endmsg;
  return StatusCode::FAILURE;
}

◆ eraseBase()

StatusCode CondContBase::eraseBase	(	const EventIDBase &	t,
		const EventContext &	ctx )

protectedinherited

Erase the first element not less than t.

Parameters

IOV	time of element to erase.
ctx	Event context for the current thread.

Definition at line 538 of file CondCont.cxx.

{
  switch (m_keyType) {
  case KeyType::RUNLBN:
    if (!t.isRunLumi()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::erase: "
          << "Non-Run/LBN key used in Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    m_condSet.erase (CondContBase::keyFromRunLBN (t), ctx);
    break;
  case KeyType::TIMESTAMP:
    if (!t.isTimeStamp()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::erase: "
          << "Non-Timestamp key used in timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    m_condSet.erase (CondContBase::keyFromTimestamp (t), ctx);
    break;
  case KeyType::SINGLE:
    break;
  default:
    std::abort();
  }
  return StatusCode::SUCCESS;
}

◆ extendLastRange()

StatusCode CondContMixedBase::extendLastRange	(	const EventIDRange &	newRange,
		const EventContext &	ctx )

finaloverridevirtual

Extend the range of the last IOV.

Parameters

newRange	New validity range.
ctx	Event context.

Returns failure if the start time of newRange does not match the start time of the last IOV in the container. Otherwise, the end time for the last IOV is changed to the end time for newRange. (If the end time for newRange is before the end of the last IOV, then nothing is changed.)

This is not implemented for mixed containers.

Implements CondContBase.

Definition at line 1056 of file CondCont.cxx.

{
  MsgStream msg (Athena::getMessageSvc(), title());
  msg << MSG::ERROR << "CondContMixedBase::extendLastRange: "
      << "extendLastRange() is not implemented for mixed containers."
      << endmsg;
  return StatusCode::FAILURE;
}

◆ extendLastRangeBase()

StatusCode CondContBase::extendLastRangeBase	(	const EventIDRange &	newRange,
		const EventContext &	ctx )

protectedinherited

Extend the range of the last IOV.

Parameters

newRange	New validity range.
ctx	Event context.

Returns failure if the start time of newRange does not match the start time of the last IOV in the container. Otherwise, the end time for the last IOV is changed to the end time for newRange. (If the end time for newRange is before the end of the last IOV, then nothing is changed.)

Definition at line 582 of file CondCont.cxx.

{
  key_type start;
  key_type stop;
  switch (m_keyType) {
  case KeyType::RUNLBN:
  case KeyType::MIXED:  // To handle the extension case of insertMixed().
    if (!newRange.start().isRunLumi()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::extendLastRange: "
          << "Non-Run/LBN range used in Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    start = keyFromRunLBN (newRange.start());
    stop  = keyFromRunLBN (newRange.stop());
    break;
  case KeyType::TIMESTAMP:
    if (!newRange.start().isTimeStamp()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::extendLastRange: "
          << "Non-timestamp range used in timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    start = keyFromTimestamp (newRange.start());
    stop  = keyFromTimestamp (newRange.stop());
    break;
  case KeyType::SINGLE:
    // Empty container.
    return StatusCode::FAILURE;
  default:
    std::abort();
  }
  
  if (m_condSet.extendLastRange (RangeKey (newRange, start, stop), ctx) >= 0)
  {
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

◆ findBase()

const void * CondContBase::findBase	(	const EventIDBase &	t,
		EventIDRange const **	r ) const

protectedinherited

Internal lookup function.

Parameters

t	IOV time to find.
r	If non-null, copy validity range of the object here.

Looks up the conditions object corresponding to the IOV time t. If found, return the pointer (as a pointer to the payload type of the most-derived CondCont). Otherwise, return nullptr.

Parameters

clid	CLID for the desired pointer type.
t	IOV time to find.
r	If non-null, copy validity range of the object here.

Looks up the conditions object corresponding to the IOV time t. If found, convert the pointer to a pointer to the type identified by CLID and return it. Otherwise, return nullptr.

Definition at line 636 of file CondCont.cxx.

{
  const void* ptr = nullptr;
  key_type key;
  switch (m_keyType) {
  case KeyType::RUNLBN:
  case KeyType::MIXED:
    if (!t.isRunLumi()) [[unlikely]] {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::findBase: "
          << "Non-Run/LBN key used in Run/LBN container."
          << endmsg;
      return nullptr;
    }
    key = keyFromRunLBN (t);
    break;
  case KeyType::TIMESTAMP:
    if (!t.isTimeStamp()) [[unlikely]] {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::findBase: "
          << "Non-timestamp key used in timestamp container."
          << endmsg;
      return nullptr;
    }
    key = keyFromTimestamp (t);
    break;
  case KeyType::SINGLE:
    // Empty container.
    return nullptr;
  default:
    std::abort();
  }
 
  CondContSet::const_iterator it = m_condSet.find (key);
  if (it && key < it->first.m_stop) {
    if (r) {
      *r = &it->first.m_range;
    }
    ptr = it->second;
  } 
 
  return ptr;
}

◆ findMixed()

const void * CondContMixedBase::findMixed	(	const EventIDBase &	t,
		EventIDRange const **	r ) const

protected

Internal lookup function.

Parameters

t	IOV time to find.
r	If non-null, copy validity range of the object here.

Looks up the conditions object corresponding to the IOV time t. If found, return the pointer (as a pointer to the payload type of the most-derived CondCont). Otherwise, return nullptr.

Definition at line 1210 of file CondCont.cxx.

{
  if (!t.isTimeStamp()) {
    MsgStream msg (Athena::getMessageSvc(), title());
    msg << MSG::ERROR << "CondContMixedBase::findMixed: "
        << "No valid timestamp in key used with mixed container."
        << endmsg;
    return nullptr;
  }
 
  auto dostall = []() { CxxUtils::stall(); return true; };
  const void* ptr = nullptr;
  CondContSet::const_iterator it;
  do {
    ptr = CondContBase::findBase (t, nullptr);
    if (!ptr) return nullptr;
 
    const CondContSet* tsmap = reinterpret_cast<const CondContSet*> (ptr);
    key_type key = keyFromTimestamp (t);
    it = tsmap->find (key);
 
    if (it && key < it->first.m_stop) {
      if (r) {
        *r = &it->first.m_range;
      }
      ptr = it->second;
    }
    else {
      ptr = nullptr;
    }
 
    // When we extend a range in a mixed container, the run/lbn fields
    // in the ts map are extended as a separate step.  This means
    // that there is a window in which we can successfully look up
    // an entry, but the range we get will have the old, unextended
    // run/lbn.  Work around here: if the run/lbn we're looking
    // for isn't in the range we get, then try again.
  } while (ptr &&
           keyFromRunLBN (t) >= keyFromRunLBN (it->first.m_range.stop()) &&
           dostall());
 
  return ptr;
}

◆ forEach()

template<class FUNC>

void CondContBase::forEach ( const FUNC & func ) const

protectedinherited

Call func on each entry in the container.

Parameters

func	Functional to call on each entry.

func will be called on each container element (being passed const CondContSet::value_type&).

◆ getDeps()

std::vector< CondContBase * > CondContBase::getDeps ( )

inherited

Return the list of conditions containers that depend on this one.

Definition at line 704 of file CondCont.cxx.

{
  return std::vector<CondContBase*> (m_deps.begin(), m_deps.end());
}

◆ id()

const DataObjID & CondContBase::id ( ) const

inherited

Return CLID/key corresponding to this container.

◆ insertBase()

StatusCode CondContBase::insertBase	(	const EventIDRange &	r,
		CondContSet::payload_unique_ptr	t,
		const EventContext &	ctx )

protectedinherited

Insert a new conditions object.

Parameters

r	Range of validity of this object.
t	Pointer to the object being inserted.
ctx	Event context for the current thread.

Returns SUCCESS if the object was successfully inserted; EXTENDED if the last existing range in the container was extended to match the new range; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Definition at line 445 of file CondCont.cxx.

{
  EventIDBase start = r.start();
  EventIDBase stop = r.stop();
 
  key_type start_key, stop_key;
 
  if (m_keyType == KeyType::MIXED) {
    if (start.run_number() == EventIDBase::UNDEFNUM ||
        stop.run_number() == EventIDBase::UNDEFNUM)
    {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Run part of range invalid in mixed container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromRunLBN (start);
    stop_key  = keyFromRunLBN (stop);
  }
  else if (start.isTimeStamp() && stop.isTimeStamp()) {
    if (m_keyType == KeyType::SINGLE) {
      m_keyType = KeyType::TIMESTAMP;
    }
    else if (m_keyType != KeyType::TIMESTAMP) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Timestamp key used in non-timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromTimestamp (start);
    stop_key  = keyFromTimestamp (stop);
  }
 
  else if (start.run_number() != EventIDBase::UNDEFNUM &&
           stop.run_number() != EventIDBase::UNDEFNUM)
  {
    if (m_keyType == KeyType::SINGLE) {
      m_keyType = KeyType::RUNLBN;
    }
    else if (m_keyType != KeyType::RUNLBN) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Run/LBN key used in non-Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromRunLBN (start);
    stop_key  = keyFromRunLBN (stop);
  }
 
  else {
    MsgStream msg (Athena::getMessageSvc(), title());
    msg << MSG::ERROR << "CondContBase::insertBase: EventIDRange " << r 
        << " is neither fully RunEvent nor TimeStamp" 
        << endmsg;
    return StatusCode::FAILURE;
  }
 
  CondContSet::EmplaceResult reslt =
    m_condSet.emplace( RangeKey(r, start_key, stop_key),
                       std::move(t),
                       m_keyType != KeyType::MIXED,
                       ctx );
 
  if (reslt == CondContSet::EmplaceResult::DUPLICATE)
  {
    return CondContStatusCode::DUPLICATE;
  }
  else if (reslt == CondContSet::EmplaceResult::EXTENDED)
  {
    return CondContStatusCode::EXTENDED;
  }
  else if (reslt == CondContSet::EmplaceResult::OVERLAP) {
    return CondContStatusCode::OVERLAP;
  }
 
  return this->inserted (ctx);
}

◆ inserted()

StatusCode CondContBase::inserted ( const EventContext & ctx )

protectedinherited

Tell the cleaner that a new object was added to the container.

Definition at line 685 of file CondCont.cxx.

{
  return m_cleanerSvc->condObjAdded (ctx, *this);
}

◆ insertError()

void CondContBase::insertError ( CLID usedCLID ) const

protectedinherited

Helper to report an error due to using a base class for insertion.

Parameters

usedCLID CLID of the class used for insertion.

Definition at line 726 of file CondCont.cxx.

{
  MsgStream msg (Athena::getMessageSvc(), title());
  msg << MSG::ERROR << "CondCont<T>::insert: Not most-derived class; "
      << "CLID used: " << usedCLID
      << "; container CLID: " << m_clid
      << endmsg;
}

◆ insertMixed()

StatusCode CondContMixedBase::insertMixed	(	const EventIDRange &	r,
		CondContBase::CondContSet::payload_unique_ptr	t,
		const EventContext &	ctx )

protected

Insert a new conditions object.

Parameters

r	Range of validity of this object.
t	Pointer to the object being inserted.
ctx	Event context for the current thread.

Returns SUCCESS if the object was successfully inserted; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Parameters

r	Range of validity of this object.
t	Pointer to the object being inserted.
ctx	Event context for the current thread.

Returns SUCCESS if the object was successfully inserted; EXTENDED if the last existing range in the container was extended to match the new range; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Definition at line 1083 of file CondCont.cxx.

{
  // Serialize insertions.
  std::lock_guard<std::mutex> lock (m_mutex);
 
  const EventIDRange* range = nullptr;
  const void* tsmap_void = findBase (r.start(), &range);
  CondContSet* tsmap ATLAS_THREAD_SAFE =
    const_cast<CondContSet*>(reinterpret_cast<const CondContSet*> (tsmap_void));
 
  // Only test start timestamp.  stop timestamp may be missing
  // for open-ended ranges.
  key_type start_key=0; //If there is no TimeStamp in start, assume infinite range
  if (r.start().isTimeStamp() ) {
    start_key = keyFromTimestamp (r.start());
  }
 
  key_type stop_key  = keyFromTimestamp (r.stop());
 
  StatusCode sc = StatusCode::SUCCESS;
  sc.ignore();
  if (tsmap) {
    if (r.start().run_number() != range->start().run_number() ||
        r.stop().run_number() != range->stop().run_number() ||
        r.start().lumi_block() != range->start().lumi_block() ||
        r.stop().lumi_block() != range->stop().lumi_block())
    {
      // Run+lbn part doesn't match.  If this range contains only a single
      // timestamp range which matches the timestamp part of the key,
      // then try to extend it.  Otherwise, give an error.
 
      bool extended = false;
      if (tsmap->size() == 1) {
        CondContSet::const_iterator elt = tsmap->find (start_key);
        if (elt) {
          if (elt->first.m_start == start_key &&
              elt->first.m_stop == stop_key)
          {
            if (extendLastRangeBase (r, ctx).isSuccess())
            {
              sc = CondContStatusCode::EXTENDED;
              sc.ignore();
              extended = true;
 
              // We also need to update the ending run+lbn value
              // for each entry in the tsmap.
              // (This doesn't affect sorting within the tsmap.)
              // There's a potential race here: a lookup happening
              // between the extendLastRangeBase above and the updateRanges
              // below can get a range with an unupdated run/lbn.
              // It would be cleaner to do the extend/update as a single
              // operation, but for now we work around by having findMixed
              // retry if the run/lbn being sought is in the range
              // of the entry that's actually found.
              tsmap->updateRanges ([&] (RangeKey& k)
                                   { EventIDBase start = k.m_range.start();
                                     EventIDBase stop = k.m_range.stop();
                                     stop.set_run_number(r.stop().run_number());
                                     stop.set_lumi_block(r.stop().lumi_block());
                                     k.m_range = EventIDRange (start, stop);
                                   },
                                   ctx);
            }
          }
        }
      }
 
      if (!extended) {
        MsgStream msg (Athena::getMessageSvc(), title());
        msg << MSG::ERROR << "CondContMixedBase::insertMixed: "
            << "Run+lbn part of new range doesn't match existing range, "
            << "or can't extend. "
            << "New: " << r << "; existing: " << *range
            << endmsg;
        return StatusCode::FAILURE;
      }
    }
  }
  else {
    auto newmap = std::make_unique<CondContSet>
      (Updater_t (m_rcusvc), m_payloadDeleter, 16);
    tsmap = newmap.get();
    sc = insertBase (r, std::move (newmap), ctx);
    if (sc.isFailure()) {
      return sc;
    }
    else if (Category::isDuplicate (sc)) {
      // Shouldn't happen...
      std::abort();
    }
  }
 
  CondContSet::EmplaceResult reslt =
    tsmap->emplace ( RangeKey(r, start_key, stop_key),
                     std::move(t), false, ctx );
 
  if (reslt == CondContSet::EmplaceResult::OVERLAP) {
    return CondContStatusCode::OVERLAP;
  }
  else if (Category::isExtended (sc)) {
    return sc;
  }
  else if (reslt == CondContSet::EmplaceResult::DUPLICATE)
  {
    return CondContStatusCode::DUPLICATE;
  }
  else if (reslt == CondContSet::EmplaceResult::EXTENDED)
  {
    std::abort();  // Shouldn't happen.
  }
  return this->inserted (ctx);
  //return sc;
}

◆ keyFromRunLBN()

key_type CondContBase::keyFromRunLBN ( const EventIDBase & b )

staticinherited

Make a run+lbn key from an EventIDBase.

Parameters

Event ID to convert.

◆ keyFromTimestamp()

key_type CondContBase::keyFromTimestamp ( const EventIDBase & b )

staticinherited

Make a timestamp key from an EventIDBase.

Parameters

Event ID to convert.

◆ keyType()

KeyType CondContBase::keyType ( ) const

inherited

Return the key type for this container.

◆ list()

void CondContMixedBase::list ( std::ostream & ost ) const

finaloverridevirtual

Dump the container contents for debugging.

Parameters

ost	Stream to which to write the dump.

Implements CondContBase.

Definition at line 919 of file CondCont.cxx.

{
  ost << "id: " << id() << "  proxy: " << proxy() << " ["
      << CondContBase::entries() << "] run+lbn entries" << std::endl;
  forEach ([&] (const CondContSet::value_type& ent)
           {
             const CondContSet* tsmap =
               reinterpret_cast<const CondContSet*> (ent.second);
             if (tsmap->empty()) {
               ost << ent.first.m_range << " (empty tsmap)" << std::endl;
             }
             else {
               for (const CondContSet::value_type& ent2 : tsmap->range()) {
                 ost << ent2.first.m_range << " " << ent2.second << std::endl;
               }
             }
           });
}

◆ maxSize()

size_t CondContBase::maxSize ( ) const

inherited

Return the maximum size of the map.

Definition at line 392 of file CondCont.cxx.

{
  return m_condSet.maxSize();
}

◆ nInserts()

size_t CondContBase::nInserts ( ) const

inherited

Return the number times an item was inserted into the map.

Definition at line 383 of file CondCont.cxx.

{
  return m_condSet.nInserts();
}

◆ payloadDelfcn()

CondContBase::delete_function * CondContMixedBase::payloadDelfcn ( ) const

protected

Return the payload deletion function for this container.

Definition at line 1259 of file CondCont.cxx.

{
  return m_payloadDeleter->delfcn();
}

◆ print()

void CondContBase::print ( ) const

inherited

Dump the container to cout.

For calling from the debugger.

Definition at line 284 of file CondCont.cxx.

{
  list (std::cout);
}

◆ proxy() [1/2]

SG::DataProxy * CondContBase::proxy ( )

inherited

Return the associated DataProxy, if any.

◆ proxy() [2/2]

const SG::DataProxy * CondContBase::proxy ( ) const

inherited

Return the associated DataProxy, if any.

◆ quiescent()

void CondContBase::quiescent ( const EventContext & ctx )

inherited

Mark that this thread is no longer accessing data from this container.

Parameters

ctx	Event context for the current thread.

This would normally be done through RCU service. Defined here for purposes of testing.

Definition at line 374 of file CondCont.cxx.

{
  m_condSet.quiescent (ctx);
}

◆ range()

bool CondContMixedBase::range	(	const EventIDBase &	t,
		EventIDRange &	r ) const

finaloverridevirtual

Return the mapped validity range for an IOV time.

Parameters

t	IOV time to check.
r[out]	The range containing `t`.

Returns true if t is mapped; false otherwise.

Implements CondContBase.

Definition at line 1013 of file CondCont.cxx.

{
  const EventIDRange* rp = nullptr;
  if (findMixed (t, &rp) != nullptr) {
    r = *rp;
    return true;
  }
  return false;
}

◆ ranges()

std::vector< EventIDRange > CondContMixedBase::ranges ( ) const

finaloverridevirtual

Return all IOV validity ranges defined in this container.

Implements CondContBase.

Definition at line 958 of file CondCont.cxx.

{
  std::vector<EventIDRange> r;
  r.reserve (entries()*2);
 
  forEach ([&] (const CondContSet::value_type& ent)
           {
             const CondContSet* tsmap =
               reinterpret_cast<const CondContSet*> (ent.second);
             for (const CondContSet::value_type& ent2 : tsmap->range()) {
               r.push_back (ent2.first.m_range);
             }
           });
 
  return r;
}

◆ setProxy()

void CondContBase::setProxy ( SG::DataProxy * proxy )

inherited

Set the associated DataProxy.

Parameters

proxy The proxy to set.

Definition at line 275 of file CondCont.cxx.

{
  m_proxy = proxy;
}

◆ title()

std::string CondContBase::title ( ) const

protectedinherited

Description of this container to use for MsgStream.

Definition at line 748 of file CondCont.cxx.

{
  return m_id.fullKey();
}

◆ trim()

size_t CondContBase::trim	(	const std::vector< key_type > &	runLbnKeys,
		const std::vector< key_type > &	TSKeys )

virtualinherited

Remove unused entries from the front of the list.

Parameters

runLbnKeys	List of Run-Lumi keys that may still be in use. (Must be sorted.)
TSKeys	List of time-stamp keys that may still be in use. (Must be sorted.)

We examine the objects in the container, starting with the earliest one. If none of the keys in keys match the range for this object, then it is removed from the container. We stop when we either find an object with a range matching a key in keys or when there is only one object left. Mixed containers are trimmed recursivly.

The list runLbnKeys should contain keys as computed by keyFromRunLBN, the list TSKey should contain keys from keyFromTimestamp. Depending on the type (RUNLUMI, TIMESTAMP, MIXED) only one of the lists or both are used. The list must be sorted.

Removed objects are queued for deletion once all slots have been marked as quiescent.

Returns the number of objects that were removed.

Parameters

keys	List of keys that may still be in use. (Must be sorted.)

We examine the objects in the container, starting with the earliest one. If none of the keys in keys match the range for this object, then it is removed from the container. We stop when we either find an object with a range matching a key in keys or when there is only one object left.

The list keys should contain keys as computed by keyFromRunLBN or keyFromTimestamp, as appropriate for the container's key type (as returned from keyType()). The list must be sorted.

Removed objects are queued for deletion once all slots have been marked as quiescent.

Returns the number of objects that were removed.

Definition at line 319 of file CondCont.cxx.

{
  if (m_keyType == KeyType::RUNLBN) {
      return m_condSet.trim (runLbnKeys);
  }
 
  if (m_keyType == KeyType::TIMESTAMP) {
    return m_condSet.trim ( TSKeys );
  }
 
 
  if (m_keyType == KeyType::MIXED) {
    //For mixed containers, first trim inner container based in TimeStamps
    size_t nTrimmed=0;
    for (const typename CondContSet::value_type& ent : m_condSet.range()) {
      const CondContSet* tsmap = reinterpret_cast<const CondContSet*> (ent.second);
      //size_t before=tsmap->size();
      CondContSet* tsmap_nc ATLAS_THREAD_SAFE = const_cast<CondContSet*>(tsmap);
      // Trim inner containers, allowing the removal of all elements.
      // See ATLASRECTS-7421.
      size_t ntrim=tsmap_nc->trim (TSKeys, true);
      nTrimmed+=ntrim;
      //std::cout << "WL: Trimming inner container for clid " << m_clid << " (" << ntrim << " out of " << before << ", nKeys= " << TSKeys.size() << ")" << std::endl;
    }
    // Then trim outer container based on run-LB.
    size_t outerTrimmed=m_condSet.trim(runLbnKeys);
    //std::cout << "WL: Removing outer sets " << outerTrimmed << ", remaining " << m_condSet.size()  << std::endl; 
    //FIXME: The number returned may be inaccurate, only correct if the outer container
    //has exactly one element left by the time it gets removed.  
    return nTrimmed+outerTrimmed; 
  }
 
//Arrive here for KeyType::SINGLE .. do nothing. 
 return 0;
}

◆ typelessInsert()

StatusCode CondContMixedBase::typelessInsert	(	const EventIDRange &	r,
		void *	obj,
		const EventContext &	ctx )

finaloverridevirtual

Insert a new conditions object.

Parameters

r	Range of validity of this object.
obj	Pointer to the object being inserted.
ctx	Event context for the current thread.

obj must point to an object of type T, except in the case of inheritance, where the type of obj must correspond to the most-derived CondCont type. The container will take ownership of this object.

Returns SUCCESS if the object was successfully inserted; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Implements CondContBase.

Definition at line 995 of file CondCont.cxx.

{
  return insertMixed (r,
                      CondContSet::payload_unique_ptr (obj, payloadDelfcn()),
                      ctx);
}

◆ valid()

virtual bool CondContMixedBase::valid ( const EventIDBase & t ) const

finaloverridevirtual

Test to see if a given IOV time is mapped in the container.

Parameters

t	IOV time to check.

Implements CondContBase.

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::string s_cleanerSvcName CondContBase::ATLAS_THREAD_SAFE

staticprivateinherited

Name of the global conditions cleaner service.

Definition at line 686 of file CondCont.h.

◆ m_cleanerSvc

ServiceHandle<Athena::IConditionsCleanerSvc> CondContBase::m_cleanerSvc

privateinherited

Handle to the cleaner service.

Definition at line 678 of file CondCont.h.

◆ m_clid

CLID CondContBase::m_clid

privateinherited

CLID of the most-derived CondCont.

Definition at line 666 of file CondCont.h.

◆ m_condSet

CondContSet CondContBase::m_condSet

privateinherited

Set of mapped objects.

Definition at line 675 of file CondCont.h.

◆ m_deps

DepSet CondContBase::m_deps

privateinherited

Definition at line 683 of file CondCont.h.

◆ m_id

DataObjID CondContBase::m_id

privateinherited

CLID+key for this container.

Definition at line 669 of file CondCont.h.

◆ m_keyType

std::atomic<KeyType> CondContBase::m_keyType

privateinherited

Key type of this container.

Definition at line 663 of file CondCont.h.

◆ m_mutex

std::mutex CondContMixedBase::m_mutex

private

Mutex for insertions.

Definition at line 1191 of file CondCont.h.

◆ m_payloadDeleter

std::shared_ptr<CondContSet::IPayloadDeleter> CondContMixedBase::m_payloadDeleter

private

Deletion object for actual payload objects.

Definition at line 1188 of file CondCont.h.

◆ m_proxy

SG::DataProxy* CondContBase::m_proxy

privateinherited

Associated DataProxy.

Definition at line 672 of file CondCont.h.

◆ m_rcusvc

Athena::IRCUSvc& CondContMixedBase::m_rcusvc

private

Need to remember the RCU svc here in order to pass it to the TS maps.

Definition at line 1185 of file CondCont.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CondContSet

◆ delete_function

◆ DepSet

◆ key_type

◆ Payload

◆ Updater_t

Member Enumeration Documentation

◆ KeyType

Constructor & Destructor Documentation

◆ CondContMixedBase()

Member Function Documentation

◆ addDep()

◆ ATLAS_NOT_THREAD_SAFE()

◆ cast()

◆ clear()

◆ clid()

◆ delfcn()

◆ doCast()

◆ entries()

◆ erase()

◆ eraseBase()

◆ extendLastRange()

◆ extendLastRangeBase()

◆ findBase()

◆ findMixed()

◆ forEach()

◆ getDeps()

◆ id()

◆ insertBase()

◆ inserted()

◆ insertError()

◆ insertMixed()

◆ keyFromRunLBN()

◆ keyFromTimestamp()

◆ keyType()

◆ list()

◆ maxSize()

◆ nInserts()

◆ payloadDelfcn()

◆ print()

◆ proxy() [1/2]

◆ proxy() [2/2]

◆ quiescent()

◆ range()

◆ ranges()

◆ setProxy()

◆ title()

◆ trim()

◆ typelessInsert()

◆ valid()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cleanerSvc

◆ m_clid

◆ m_condSet

◆ m_deps

◆ m_id

◆ m_keyType

◆ m_mutex

◆ m_payloadDeleter

◆ m_proxy

◆ m_rcusvc