ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
TrigCOOLUpdateHelper Class Reference

Tool to perform COOL updates during the run. More...

#include <TrigCOOLUpdateHelper.h>

Inheritance diagram for TrigCOOLUpdateHelper:
Collaboration diagram for TrigCOOLUpdateHelper:

Public Member Functions

 TrigCOOLUpdateHelper (const std::string &type, const std::string &name, const IInterface *parent)
 
virtual StatusCode initialize () override
 
virtual StatusCode start () override
 
virtual StatusCode stop () override
 
StatusCode hltCoolUpdate (const EventContext &ctx)
 Perform COOL udpates if needed. More...
 
StatusCode hltCoolUpdate (const std::string &folder)
 Update specified COOL folder. More...
 
StatusCode getFolderName (CTPfragment::FolderIndex idx, std::string &folderName) const
 Return folder name to index. More...
 
StatusCode extractFolderUpdates (const EventContext &ctx)
 Decode COOL folder updates according to extra payload in CTP fragment. More...
 
StatusCode readFolderInfo ATLAS_NOT_THREAD_SAFE ()
 Read information about existing COOL folders. More...
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce (T &h)
 
void extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
 Add StoreName to extra input/output deps as needed. More...
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

StatusCode resetFolder (const std::string &folder)
 Reset COOL folder. More...
 
StatusCode resetFolders (const std::vector< std::string > &folders)
 Reset list of COOL folders. More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

std::map< std::string, FolderInfom_folderInfo
 CLID/name mapping of COOL folders. More...
 
std::map< CTPfragment::FolderIndex, FolderUpdatem_folderUpdates
 Map to store scheduled/done COOL folder updates. More...
 
std::map< CTPfragment::FolderIndex, std::string > m_folderNames
 Map to store the folder update index -> name mapping. More...
 
SmartIF< IIOVSvcm_iovSvc
 
SmartIF< IIOVDbSvcm_iovDbSvc
 
ServiceHandle< IROBDataProviderSvcm_robDataProviderSvc
 
ToolHandle< GenericMonitoringToolm_monTool {this, "MonTool", {}, "Monitoring tool"}
 
Gaudi::Property< std::string > m_coolFolderName
 
Gaudi::Property< std::vector< std::string > > m_folders
 
Gaudi::Property< uint32_t > m_ctpRobId
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Detailed Description

Tool to perform COOL updates during the run.

Definition at line 59 of file TrigCOOLUpdateHelper.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrigCOOLUpdateHelper()

TrigCOOLUpdateHelper::TrigCOOLUpdateHelper ( const std::string &  type,
const std::string &  name,
const IInterface *  parent 
)

Definition at line 31 of file TrigCOOLUpdateHelper.cxx.

35  m_robDataProviderSvc("ROBDataProviderSvc", name)
36 {}

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE()

StatusCode readFolderInfo TrigCOOLUpdateHelper::ATLAS_NOT_THREAD_SAFE ( )

Read information about existing COOL folders.

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extractFolderUpdates()

StatusCode TrigCOOLUpdateHelper::extractFolderUpdates ( const EventContext &  ctx)

Decode COOL folder updates according to extra payload in CTP fragment.

Definition at line 251 of file TrigCOOLUpdateHelper.cxx.

252 {
253  using CTPfragment::FolderIndex;
255 
256  // Fetch CTP fragment ROB
257  const std::vector<uint32_t> robs{m_ctpRobId};
259  try {
260  m_robDataProviderSvc->addROBData(ctx, robs, name());
261  m_robDataProviderSvc->getROBData(ctx, robs, ctpRobs, name());
262  }
263  catch (const std::exception& ex) {
264  ATH_MSG_ERROR("Cannot retrieve CTP ROB 0x" << MSG::hex << m_ctpRobId.value() << MSG::dec << " due to exception: " << ex.what());
265  return StatusCode::FAILURE;
266  }
267 
268  if ( ctpRobs.empty() ) {
269  ATH_MSG_ERROR("Cannot retrieve CTP ROB 0x" << MSG::hex << m_ctpRobId.value() << MSG::dec);
270  return StatusCode::FAILURE;
271  }
272 
273  // Decode CTP extra payload words
274  std::vector<uint32_t> l1_extraPayload = CTPfragment::extraPayloadWords( ctpRobs[0] );
275  CTPfragment::ExtraPayload ctp_payload;
276  try {
277  ctp_payload = CTPfragment::ExtraPayload(l1_extraPayload);
278  }
279  catch (CTPfragment::ExtraPayloadTooLong& ex) {
280  ATH_MSG_ERROR("Invalid CTP fragment. Exception = " << ex.what());
281  return StatusCode::FAILURE;
282  }
283 
284  if ( msgLevel(MSG::DEBUG) ) {
285  msg() << MSG::DEBUG << "CTP extra payload (" << l1_extraPayload.size() << " words): ";
286  for (std::size_t i=0; i<l1_extraPayload.size(); ++i) {
287  msg() << " " << l1_extraPayload[i];
288  }
289  std::ostringstream out;
290  out << ctp_payload;
291  msg() << out.str() << endmsg;
292  }
293 
294  // Loop over potential new folder updates
295  for (const std::pair<const FolderIndex, FolderEntry>& kv : ctp_payload.getFolderUpdates()) {
296 
297  // Check if we already have an update for this folder
298  std::map<FolderIndex, FolderUpdate>::const_iterator f = m_folderUpdates.find(kv.first);
299 
300  // No updates yet or this update supersedes the previous one
301  if (f==m_folderUpdates.end() || (f->second.lumiBlock != kv.second.lumiBlock)) {
302  m_folderUpdates[kv.first] = FolderUpdate(kv.second); // new folder update
303 
304  ATH_MSG_DEBUG("Conditions update for folder " << kv.second.folderIndex
305  << " on lumiblock " << kv.second.lumiBlock);
306  }
307  }
308  return StatusCode::SUCCESS;
309 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getFolderName()

StatusCode TrigCOOLUpdateHelper::getFolderName ( CTPfragment::FolderIndex  idx,
std::string &  folderName 
) const

Return folder name to index.

Parameters
idxFolder index
folderNameReturns folder name

Definition at line 231 of file TrigCOOLUpdateHelper.cxx.

232 {
233  const auto& itr = m_folderNames.find(idx);
234  if (itr==m_folderNames.end()) {
235  ATH_MSG_ERROR(m_coolFolderName << " does not contain a folder for index/channel " << idx
236  << ". Existing folders are:");
237  for (auto const& [idx, name] : m_folderNames) {
238  ATH_MSG_INFO(" (" << idx << ") " << name);
239  }
240  return StatusCode::FAILURE;
241  }
242 
243  folderName = itr->second;
244  return StatusCode::SUCCESS;
245 }

◆ hltCoolUpdate() [1/2]

StatusCode TrigCOOLUpdateHelper::hltCoolUpdate ( const EventContext &  ctx)

Perform COOL udpates if needed.

Parameters
ctxEvent context

Definition at line 171 of file TrigCOOLUpdateHelper.cxx.

172 {
173  // Extract COOL folder updates from CTP fragment
174  if ( extractFolderUpdates(ctx).isFailure() ) {
175  ATH_MSG_ERROR("Failure reading CTP extra payload");
176  return StatusCode::FAILURE;
177  }
178 
179  // Loop over folders to be updated
180  for (auto& [idx, f] : m_folderUpdates) {
181 
182  if (f.needsUpdate) {
183 
184  if ( !m_iovSvc || m_coolFolderName.empty() ) {
185  ATH_MSG_DEBUG("Request to reload COOL folder ID " << idx << " for IOV change in lumiblock "
186  << f.lumiBlock << " but running without IOVSvc. Current event: " << ctx.eventID());
187  f.needsUpdate = false;
188  continue;
189  }
190 
191  std::string folderName;
192  if (getFolderName(f.folderIndex, folderName).isFailure()) {
193  continue; // On purpose not a failure
194  }
195 
196  ATH_MSG_INFO("Reload of COOL folder " << folderName << " for IOV change in lumiblock "
197  << f.lumiBlock << ". Current event: " << ctx.eventID());
198 
199  if ( hltCoolUpdate(folderName).isFailure() ) {
200  ATH_MSG_ERROR("COOL update failed for " << folderName << ". Aborting.");
201  return StatusCode::FAILURE;
202  }
203  // All OK
204  f.needsUpdate = false;
205  }
206  }
207 
208  return StatusCode::SUCCESS;
209 }

◆ hltCoolUpdate() [2/2]

StatusCode TrigCOOLUpdateHelper::hltCoolUpdate ( const std::string &  folder)

Update specified COOL folder.

Parameters
folderFolder name

Definition at line 211 of file TrigCOOLUpdateHelper.cxx.

212 {
213  if (std::find(m_folders.begin(), m_folders.end(), folderName)==m_folders.end()) {
214  ATH_MSG_ERROR("Received request to update COOL folder '" << folderName
215  << "' but this folder is not in the allowed list:" << m_folders);
216  return StatusCode::FAILURE;
217  }
218 
219  auto mon_t = Monitored::Timer("TIME_CoolFolderUpdate");
221 
222  // Reset folder and make IOVDbSvc drop objects
223  if (resetFolder(folderName).isFailure()) {
224  ATH_MSG_ERROR("Reset of " << folderName << " failed");
225  return StatusCode::FAILURE;
226  }
227 
228  return StatusCode::SUCCESS;
229 }

◆ initialize()

StatusCode TrigCOOLUpdateHelper::initialize ( )
overridevirtual

Definition at line 39 of file TrigCOOLUpdateHelper.cxx.

40 {
41  // Do not create these services if they are not available already
42  m_iovSvc = service("IOVSvc", /*createIf=*/false);
43  m_iovDbSvc = service("IOVDbSvc", /*createIf=*/false);
44 
45  if (!m_monTool.empty()) ATH_CHECK(m_monTool.retrieve());
46 
47  return StatusCode::SUCCESS;
48 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ resetFolder()

StatusCode TrigCOOLUpdateHelper::resetFolder ( const std::string &  folder)
private

Reset COOL folder.

Parameters
folderCOOL folder name

Definition at line 131 of file TrigCOOLUpdateHelper.cxx.

132 {
133  // Force a reset of folders by setting an IOVRange in the past
134 
135  if (!m_iovSvc || !m_iovDbSvc) return StatusCode::SUCCESS;
136 
137  const auto& f = m_folderInfo.find(folder);
138  if ( f==m_folderInfo.end() ) {
139  ATH_MSG_DEBUG("Folder " << folder << " not registered with IOVDbSvc");
140  return StatusCode::SUCCESS;
141  }
142 
143  const CLID& clid = f->second.clid;
144  const std::string& key = f->second.key;
145 
146  // Make sure we are not trying to reset a time-based folder
147  IOVRange iov;
148  if ( m_iovSvc->getRange(clid, key, iov).isSuccess() ) {
149  if ( iov.start().isTimestamp() || iov.start().isBoth() ) {
150  ATH_MSG_ERROR(folder << " is not a Run/LB based folder. Cannot perform COOL update.");
151  return StatusCode::FAILURE;
152  }
153  }
154 
155  if ( m_iovSvc->dropObjectFromDB(clid, key, "StoreGateSvc").isFailure() ) {
156  ATH_MSG_WARNING("Could not invalidate folder " << folder);
157  return StatusCode::FAILURE;
158  }
159 
160  // All OK
161  ATH_MSG_INFO("Invalidated IOV and dropped payload of folder " <<
162  folder << (key!=folder ? " (key="+key+")" : "") );
163 
164  return StatusCode::SUCCESS;
165 }

◆ resetFolders()

StatusCode TrigCOOLUpdateHelper::resetFolders ( const std::vector< std::string > &  folders)
private

Reset list of COOL folders.

Parameters
foldersList of folder names

Definition at line 118 of file TrigCOOLUpdateHelper.cxx.

119 {
120  if (folders.empty()) return StatusCode::SUCCESS;
121 
122  StatusCode sc(StatusCode::SUCCESS);
123  for (const std::string& f : folders) {
124  if ( resetFolder(f).isFailure() ) {
125  sc = StatusCode::FAILURE;
126  }
127  }
128  return sc;
129 }

◆ start()

StatusCode TrigCOOLUpdateHelper::start ( )
overridevirtual

Definition at line 51 of file TrigCOOLUpdateHelper.cxx.

52 {
53  m_folderUpdates.clear();
54  return StatusCode::SUCCESS;
55 }

◆ stop()

StatusCode TrigCOOLUpdateHelper::stop ( )
overridevirtual

Definition at line 57 of file TrigCOOLUpdateHelper.cxx.

58 {
59  std::ostringstream pending;
60  // Loop over folder updates
61  for (auto f : m_folderUpdates) {
62  if (f.second.needsUpdate) pending << "[" << f.second.lumiBlock << "," << f.second.folderIndex << "]";
63  }
64 
65  if (pending.str().empty()) pending << "NONE";
66  ATH_MSG_INFO("[LB,Folder] with pending COOL updates: " << pending.str());
67 
68  return StatusCode::SUCCESS;
69 }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_coolFolderName

Gaudi::Property<std::string> TrigCOOLUpdateHelper::m_coolFolderName
private
Initial value:
{
this, "CoolFolderMap", {}, "Name of COOL folder containing folder map"}

Definition at line 126 of file TrigCOOLUpdateHelper.h.

◆ m_ctpRobId

Gaudi::Property<uint32_t> TrigCOOLUpdateHelper::m_ctpRobId
private
Initial value:
{
this, "CtpRobId", 0x770001, "ROB ID of CTP fragment containing the extra payload"}

Definition at line 132 of file TrigCOOLUpdateHelper.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_folderInfo

std::map<std::string, FolderInfo> TrigCOOLUpdateHelper::m_folderInfo
private

CLID/name mapping of COOL folders.

Definition at line 110 of file TrigCOOLUpdateHelper.h.

◆ m_folderNames

std::map<CTPfragment::FolderIndex, std::string> TrigCOOLUpdateHelper::m_folderNames
private

Map to store the folder update index -> name mapping.

Definition at line 116 of file TrigCOOLUpdateHelper.h.

◆ m_folders

Gaudi::Property<std::vector<std::string> > TrigCOOLUpdateHelper::m_folders
private
Initial value:
{
this, "Folders", {}, "List of folders that can be updated during the run"}

Definition at line 129 of file TrigCOOLUpdateHelper.h.

◆ m_folderUpdates

std::map<CTPfragment::FolderIndex, FolderUpdate> TrigCOOLUpdateHelper::m_folderUpdates
private

Map to store scheduled/done COOL folder updates.

Definition at line 113 of file TrigCOOLUpdateHelper.h.

◆ m_iovDbSvc

SmartIF<IIOVDbSvc> TrigCOOLUpdateHelper::m_iovDbSvc
private

Definition at line 120 of file TrigCOOLUpdateHelper.h.

◆ m_iovSvc

SmartIF<IIOVSvc> TrigCOOLUpdateHelper::m_iovSvc
private

Definition at line 119 of file TrigCOOLUpdateHelper.h.

◆ m_monTool

ToolHandle<GenericMonitoringTool> TrigCOOLUpdateHelper::m_monTool {this, "MonTool", {}, "Monitoring tool"}
private

Definition at line 124 of file TrigCOOLUpdateHelper.h.

◆ m_robDataProviderSvc

ServiceHandle<IROBDataProviderSvc> TrigCOOLUpdateHelper::m_robDataProviderSvc
private

Definition at line 121 of file TrigCOOLUpdateHelper.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
TrigCOOLUpdateHelper::m_folderNames
std::map< CTPfragment::FolderIndex, std::string > m_folderNames
Map to store the folder update index -> name mapping.
Definition: TrigCOOLUpdateHelper.h:116
dqt_zlumi_alleff_HIST.iov
iov
Definition: dqt_zlumi_alleff_HIST.py:119
IOVRange
Validity Range object. Holds two IOVTimes (start and stop)
Definition: IOVRange.h:30
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
find
std::string find(const std::string &s)
return a remapped string
Definition: hcg.cxx:135
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
TrigCOOLUpdateHelper::m_folders
Gaudi::Property< std::vector< std::string > > m_folders
Definition: TrigCOOLUpdateHelper.h:129
python.AthDsoLogger.out
out
Definition: AthDsoLogger.py:71
Monitored::Group
Group of local monitoring quantities and retain correlation when filling histograms
Definition: MonitoredGroup.h:54
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
TrigCOOLUpdateHelper::m_folderInfo
std::map< std::string, FolderInfo > m_folderInfo
CLID/name mapping of COOL folders.
Definition: TrigCOOLUpdateHelper.h:110
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:27
TrigCOOLUpdateHelper::m_monTool
ToolHandle< GenericMonitoringTool > m_monTool
Definition: TrigCOOLUpdateHelper.h:124
TrigCOOLUpdateHelper::m_iovSvc
SmartIF< IIOVSvc > m_iovSvc
Definition: TrigCOOLUpdateHelper.h:119
TrigCOOLUpdateHelper::extractFolderUpdates
StatusCode extractFolderUpdates(const EventContext &ctx)
Decode COOL folder updates according to extra payload in CTP fragment.
Definition: TrigCOOLUpdateHelper.cxx:251
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
lumiFormat.i
int i
Definition: lumiFormat.py:85
TrigCOOLUpdateHelper::m_iovDbSvc
SmartIF< IIOVDbSvc > m_iovDbSvc
Definition: TrigCOOLUpdateHelper.h:120
TrigCOOLUpdateHelper::m_folderUpdates
std::map< CTPfragment::FolderIndex, FolderUpdate > m_folderUpdates
Map to store scheduled/done COOL folder updates.
Definition: TrigCOOLUpdateHelper.h:113
endmsg
#define endmsg
Definition: AnalysisConfig_Ntuple.cxx:63
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
python.HLT.CommonSequences.EventBuildingSequences.robs
robs
Definition: EventBuildingSequences.py:401
TrigCOOLUpdateHelper::getFolderName
StatusCode getFolderName(CTPfragment::FolderIndex idx, std::string &folderName) const
Return folder name to index.
Definition: TrigCOOLUpdateHelper.cxx:231
calibdata.exception
exception
Definition: calibdata.py:496
test_pyathena.parent
parent
Definition: test_pyathena.py:15
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
hist_file_dump.f
f
Definition: hist_file_dump.py:135
IROBDataProviderSvc::VROBFRAG
std::vector< const ROBF * > VROBFRAG
Definition: IROBDataProviderSvc.h:27
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
CLID
uint32_t CLID
The Class ID type.
Definition: Event/xAOD/xAODCore/xAODCore/ClassID_traits.h:47
AthAlgTool::AthAlgTool
AthAlgTool()
Default constructor:
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
CaloCellTimeCorrFiller.folderName
string folderName
Definition: CaloCellTimeCorrFiller.py:20
TrigCOOLUpdateHelper::m_ctpRobId
Gaudi::Property< uint32_t > m_ctpRobId
Definition: TrigCOOLUpdateHelper.h:132
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
TrigCOOLUpdateHelper::m_coolFolderName
Gaudi::Property< std::string > m_coolFolderName
Definition: TrigCOOLUpdateHelper.h:126
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:221
TrigCOOLUpdateHelper::resetFolder
StatusCode resetFolder(const std::string &folder)
Reset COOL folder.
Definition: TrigCOOLUpdateHelper.cxx:131
a
TList * a
Definition: liststreamerinfos.cxx:10
h
makeDTCalibBlob_pickPhase.folders
folders
Definition: makeDTCalibBlob_pickPhase.py:346
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
TrigCOOLUpdateHelper::m_robDataProviderSvc
ServiceHandle< IROBDataProviderSvc > m_robDataProviderSvc
Definition: TrigCOOLUpdateHelper.h:121
python.CTPfragment.ExtraPayload
ExtraPayload
Definition: CTPfragment.py:25
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
DEBUG
#define DEBUG
Definition: page_access.h:11
plotBeamSpotMon.mon
mon
Definition: plotBeamSpotMon.py:67
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
TrigCOOLUpdateHelper::hltCoolUpdate
StatusCode hltCoolUpdate(const EventContext &ctx)
Perform COOL udpates if needed.
Definition: TrigCOOLUpdateHelper.cxx:171
LArNewCalib_DelayDump_OFC_Cali.idx
idx
Definition: LArNewCalib_DelayDump_OFC_Cali.py:69
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
CaloCondBlobAlgs_fillNoiseFromASCII.folder
folder
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:56
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
FolderUpdate
Folder update entry.
Definition: TrigCOOLUpdateHelper.h:44
python.CTPfragment.FolderEntry
FolderEntry
Definition: CTPfragment.py:24
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
Monitored::Timer
A monitored timer.
Definition: MonitoredTimer.h:32
fitman.k
k
Definition: fitman.py:528
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37