AthenaBarCodeBase Class Reference

#include <AthenaBarCodeBase.h>

Inheritance diagram for AthenaBarCodeBase:

Collaboration diagram for AthenaBarCodeBase:

Public Member Functions
virtual AthenaBarCode_t	getAthenaBarCode () const
virtual void	setAthenaBarCode (AthenaBarCode_t id)
virtual bool	hasSameAthenaBarCode (const IAthenaBarCode &obj) const
virtual bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &obj) const
virtual AthenaBarCodeVersion_t	getVersion () const
virtual void	newVersion ()
virtual void	setVersion (AthenaBarCodeVersion_t newversion)
std::ostream &	dump (std::ostream &out) const
bool	createdInCurrentJob () const
AthenaBarCode_t	getReserveBits () const
void	setReserveBits (AthenaBarCode_t id)

Static Public Member Functions
static void	setDefaultHash (const char *jobid)

Static Public Attributes
static const unsigned short	TotalBits = 64
static const unsigned short	UUIDBits = 32
static const unsigned short	CounterBits = 26
static const unsigned short	VersionBits = 4
static const unsigned short	ReserveBits = 2
static const unsigned short	SUUIDBits = 0
static const unsigned short	SCounterBits = UUIDBits
static const unsigned short	SVersionBits = UUIDBits+CounterBits
static const unsigned short	SReserveBits = UUIDBits+CounterBits+VersionBits
static const AthenaBarCode_t	UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)
static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Protected Member Functions
void	setBits (unsigned short startbit, unsigned short nbits, AthenaBarCode_t id, AthenaBarCode_t &bc) const
AthenaBarCode_t	getBits (unsigned short startbit, unsigned short nbits) const
void	initABC () const

Private Member Functions
AthenaBarCode_t	combineWithUUIDHash (const AthenaBarCode_t &) const
void	setUUIDHash (AthenaBarCode_t uuidhash)
AthenaBarCode_t	hasUUIDHash () const
AthenaBarCode_t	getUUIDHash () const

Static Private Member Functions
static AthenaBarCode_t	hashUUID (const char *)
static AthenaBarCode_t	getDefaultHash (const char *jobid=nullptr)
static AthenaBarCode_t	makeDefaultHash (const char *jobid)

Private Attributes
std::atomic< AthenaBarCode_t >	m_barcode

Static Private Attributes
static std::atomic< AthenaBarCode_t >	m_barcodeCounter = 0

Detailed Description

Definition at line 26 of file AthenaBarCodeBase.h.

Member Function Documentation

combineWithUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::combineWithUUIDHash ( const AthenaBarCode_t & hash ) const

inlineprivateinherited

Definition at line 119 of file AthenaBarCodeImpl.h.

                                                                     {
  
  AthenaBarCode_t tmp = 0;
  AthenaBarCode_t lowerh = ~tmp >> (TotalBits
                    - UUIDBits);
  AthenaBarCode_t higherh = ~tmp << (UUIDBits);
  
  AthenaBarCode_t lower = m_barcode & lowerh;
  AthenaBarCode_t higher = hash & higherh;
  
  /*
    std::cout << "AthenaBarCodeImpl::combineWithHash::hash=" << std::hex
    << hash << " lower=" << lower << " higher=" << higher << " lowerh="
    << lowerh << " higherh=" << higherh << " barcode=" << (lower
    | higher) << std::endl;
  */
  return lower | higher;
    
}

createdInCurrentJob()

bool AthenaBarCodeImpl::createdInCurrentJob ( ) const

inherited

Definition at line 181 of file AthenaBarCodeImpl.cxx.

                                             {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  //FIXME: it is possible that m_defaultHash is not yet initialized.
  return getUUIDHash() == getDefaultHash();
}

dump()

std::ostream & AthenaBarCodeImpl::dump ( std::ostream & out ) const

inherited

Definition at line 172 of file AthenaBarCodeImpl.cxx.

                                             {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  out << "\n[AthenaBarCode]= " << std::hex << (m_barcode) << std::dec << std::endl;
  return out;
}

getAthenaBarCode()

AthenaBarCode_t AthenaBarCodeBase::getAthenaBarCode ( ) const

virtual

Reimplemented from IAthenaBarCode.

Definition at line 22 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::getAthenaBarCode();
}

getBits()

AthenaBarCode_t AthenaBarCodeImpl::getBits ( unsigned short startbit, unsigned short nbits ) const

protectedinherited

Definition at line 249 of file AthenaBarCodeImpl.cxx.

                                                                              {
 
  AthenaBarCode_t tmp;
  //now m_barcode=aaaaaxxaa;
  tmp = m_barcode << (startbit); //tmp=xxaa00000;
  tmp = tmp >> (TotalBits - nbits); //tmp=0000000xx
 
  return tmp;
}

getDefaultHash()

AthenaBarCode_t AthenaBarCodeImpl::getDefaultHash ( const char * jobid = nullptr )

staticprivateinherited

Definition at line 304 of file AthenaBarCodeImpl.cxx.

{
  static const AthenaBarCode_t defaultHash = makeDefaultHash (jobid);
  return defaultHash;
}

getReserveBits()

AthenaBarCode_t AthenaBarCodeImpl::getReserveBits ( ) const

inherited

Definition at line 216 of file AthenaBarCodeImpl.cxx.

                                        {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
  return getBits(SReserveBits, ReserveBits);
}

getUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::getUUIDHash ( ) const

privateinherited

Definition at line 244 of file AthenaBarCodeImpl.cxx.

                                     {
  return getBits(SUUIDBits, UUIDBits);
}

getVersion()

AthenaBarCodeVersion_t AthenaBarCodeBase::getVersion ( ) const

virtual

Reimplemented from IAthenaBarCode.

Definition at line 47 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::getVersion();
}

hashUUID()

AthenaBarCode_t AthenaBarCodeImpl::hashUUID ( const char * guid )

staticprivateinherited

Definition at line 190 of file AthenaBarCodeImpl.cxx.

                                            {
  const int maxdigs = 16;
  AthenaBarCode_t tmp1 = static_cast<AthenaBarCode_t> (2166136261UL);
 
  for (int i = 0; i < maxdigs; i++) {
    tmp1 ^= (AthenaBarCode_t)(guid[i]);
    tmp1 *= 16777619UL;
  }
 
  return (tmp1 << (TotalBits - UUIDBits)) >> (TotalBits - UUIDBits);
}

hasSameAthenaBarCode()

bool AthenaBarCodeBase::hasSameAthenaBarCode ( const IAthenaBarCode & obj ) const

virtual

Reimplemented from IAthenaBarCode.

Definition at line 34 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::hasSameAthenaBarCode (obj);
}

hasSameAthenaBarCodeExceptVersion()

bool AthenaBarCodeBase::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & obj ) const

virtual

Reimplemented from IAthenaBarCode.

Definition at line 41 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::hasSameAthenaBarCodeExceptVersion (obj);
}

hasUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::hasUUIDHash ( ) const

privateinherited

Definition at line 239 of file AthenaBarCodeImpl.cxx.

                                     {
  return getUUIDHash();
}

initABC()

void AthenaBarCodeImpl::initABC ( ) const

protectedinherited

Definition at line 24 of file AthenaBarCodeImpl.cxx.

                                      {
 
  //This function will be call the first time any "access" function is called
  //using const type because those "access" functions might be const
  //Will only change mutable variables
 
  //  std::cout<<"Calling AthenaBarCodeImpl::AthenaBarCodeImpl() "<<std::endl;
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set counter part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 
  const AthenaBarCode_t counter = m_barcodeCounter++;
 
  AthenaBarCode_t barcode = IAthenaBarCode::UNDEFINEDBARCODE;
 
  try {
    setBits(SCounterBits, CounterBits, counter & ((1u<<CounterBits)-1),
            barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not Set Counter Bit, Counter Overflow");
  }
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set reserve part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  try {
    setBits(SReserveBits, ReserveBits, 0, barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not initialize Reserve Bit");
  }
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set Version part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  try {
    setBits(SVersionBits, VersionBits, 0, barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not initialize Version Bit");
  }
 
 
  try {
    setBits(SUUIDBits, UUIDBits, getDefaultHash(), barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error("AthenaBarCodeImpl::Can not set UUID Hash Bits");
  }
 
  m_barcode = barcode;
 
  /*  std::cout << "[AthenaBarCodeImpl::m_barcode,m_defaultHash,m_barcodeCounter]= "
   << std::hex
   << (m_barcode)<< "\t"
   << m_defaultHash<< "\t"
   << (m_barcodeCounter)<<"\t"
   << std::dec
   << std::endl;
   */
}

makeDefaultHash()

AthenaBarCode_t AthenaBarCodeImpl::makeDefaultHash ( const char * jobid )

staticprivateinherited

Definition at line 312 of file AthenaBarCodeImpl.cxx.

{
  if (jobid) {
    return AthenaBarCodeImpl::hashUUID(jobid);
  }
 
  // First look for a uuid as an environment variable.
  // This can be set in cases where we don't have the full
  // Gaudi/Athena environment available (eg, ARA), and we
  // don't want to try to create JobIDSvc.  This has to be
  // communicated in some way external to this library,
  // as we may end up here while initializing the dictionary
  // for this library.
  const char* env_uuid = getenv ("_ATHENABARCODEIMPL_JOBUUID");
  if (env_uuid) {
    return AthenaBarCodeImpl::hashUUID(env_uuid);
  }
 
  //    std::cout<<"no UUID stored, generating."<<std::endl;
 
  ServiceHandle<IJobIDSvc> p_jobidsvc("JobIDSvc", "JobIDSvc");
  StatusCode sc = p_jobidsvc.retrieve();
  if (!sc.isSuccess() || 0 == p_jobidsvc) {
    //FIXME
    //use uuid instead if service not available
    JobID_t JobID;
    uuid_generate(JobID);
    return AthenaBarCodeImpl::hashUUID((const char *) JobID);
    /*      std::cout << "Could not find JobIDSvc, using uuid directly"
            <<"jobid "<<o.str()
            << std::endl;*/
  }
 
  PJobID_t pjobid = p_jobidsvc->getJobID();
  return AthenaBarCodeImpl::hashUUID((const char *) pjobid);
}

newVersion()

void AthenaBarCodeBase::newVersion ( )

virtual

Reimplemented from IAthenaBarCode.

Definition at line 53 of file AthenaBarCodeBase.cxx.

{
  AthenaBarCodeImpl::newVersion();
}

setAthenaBarCode()

void AthenaBarCodeBase::setAthenaBarCode ( AthenaBarCode_t id )

virtual

Reimplemented from IAthenaBarCode.

Definition at line 28 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::setAthenaBarCode (id);
}

setBits()

void AthenaBarCodeImpl::setBits ( unsigned short startbit, unsigned short nbits, AthenaBarCode_t id, AthenaBarCode_t & bc ) const

protectedinherited

now id=0000000xx;

Definition at line 260 of file AthenaBarCodeImpl.cxx.

{
  AthenaBarCode_t tmp;
  AthenaBarCode_t tmp2;
  tmp2 = 0;
 
  if ((id) >= ((~tmp2) >> (TotalBits - nbits))) {
 
    IMessageSvc *msgsvc = Athena::getMessageSvc();
    if (msgsvc) {
      MsgStream msg(msgsvc, "AthenaBarCodeImpl");
      msg << MSG::WARNING << "setBits::bit to be set:" << id
          << " is larger than limit:" << ((~tmp2) >> (TotalBits - nbits))
          << endmsg;
    }
    else {
      std::cout << "setBits::bit to be set:" << id << " is larger than limit:"
          << ((~tmp2) >> (TotalBits - nbits)) << std::endl;
    }
    throw std::runtime_error("AthenaBarCodeImpl::setBit Failed");
  }

  tmp = (id << (TotalBits - nbits - startbit)); //tmp=00000xx00
  tmp2 = ((~tmp2) >> (TotalBits - nbits)); //tmp2=000000011
 
  tmp2 = (tmp2 << (TotalBits - nbits - startbit)); //tmp2=000001100
  tmp2 = (~tmp2); //tmp2=111110011
 
  //now m_barcode=aaaaayyaa
  bc &= tmp2; //m_barcode=aaaaa00aa
  bc |= tmp; //m_barcode=aaaaaxxaa
 
}

setDefaultHash()

void AthenaBarCodeImpl::setDefaultHash ( const char * jobid )

staticinherited

Definition at line 298 of file AthenaBarCodeImpl.cxx.

                                                   {
  getDefaultHash (jobid);
}

setReserveBits()

void AthenaBarCodeImpl::setReserveBits ( AthenaBarCode_t id )

inherited

Definition at line 223 of file AthenaBarCodeImpl.cxx.

                                                    {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  try {
    AthenaBarCode_t bc = m_barcode;
    setBits(SReserveBits, ReserveBits, id, bc);
    m_barcode = bc;
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::newVersion()::Version Overflow");
  }
}

setUUIDHash()

void AthenaBarCodeImpl::setUUIDHash ( AthenaBarCode_t uuidhash )

inlineprivateinherited

Definition at line 114 of file AthenaBarCodeImpl.h.

                                                                   {
  m_barcode = combineWithUUIDHash(uuidhash);
}

setVersion()

void AthenaBarCodeBase::setVersion ( AthenaBarCodeVersion_t newversion )

virtual

Reimplemented from IAthenaBarCode.

Definition at line 59 of file AthenaBarCodeBase.cxx.

{
  AthenaBarCodeImpl::setVersion (newversion);
}

Member Data Documentation

CounterBits

const unsigned short AthenaBarCodeImpl::CounterBits = 26

staticinherited

Definition at line 44 of file AthenaBarCodeImpl.h.

m_barcode

std::atomic<AthenaBarCode_t> AthenaBarCodeImpl::m_barcode

mutableprivateinherited

Definition at line 110 of file AthenaBarCodeImpl.h.

m_barcodeCounter

std::atomic< AthenaBarCode_t > AthenaBarCodeImpl::m_barcodeCounter = 0

staticprivateinherited

Definition at line 109 of file AthenaBarCodeImpl.h.

ReserveBits

const unsigned short AthenaBarCodeImpl::ReserveBits = 2

staticinherited

Definition at line 46 of file AthenaBarCodeImpl.h.

SCounterBits

const unsigned short AthenaBarCodeImpl::SCounterBits = UUIDBits

staticinherited

Definition at line 49 of file AthenaBarCodeImpl.h.

SReserveBits

const unsigned short AthenaBarCodeImpl::SReserveBits = UUIDBits+CounterBits+VersionBits

staticinherited

Definition at line 51 of file AthenaBarCodeImpl.h.

SUUIDBits

const unsigned short AthenaBarCodeImpl::SUUIDBits = 0

staticinherited

Definition at line 48 of file AthenaBarCodeImpl.h.

SVersionBits

const unsigned short AthenaBarCodeImpl::SVersionBits = UUIDBits+CounterBits

staticinherited

Definition at line 50 of file AthenaBarCodeImpl.h.

TotalBits

const unsigned short AthenaBarCodeImpl::TotalBits = 64

staticinherited

Definition at line 41 of file AthenaBarCodeImpl.h.

UNDEFINEDBARCODE

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)

staticinherited

Definition at line 52 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

UNDEFINEDVERSION

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDVERSION = UNDEFINEDBARCODE

staticinherited

Definition at line 53 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

UUIDBits

const unsigned short AthenaBarCodeImpl::UUIDBits = 32

staticinherited

Definition at line 43 of file AthenaBarCodeImpl.h.

VersionBits

const unsigned short AthenaBarCodeImpl::VersionBits = 4

staticinherited

Definition at line 45 of file AthenaBarCodeImpl.h.

---

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

• AthenaBarCodeBase.h
• AthenaBarCodeBase.cxx