ReadBchFromCool.py

Go to the documentation of this file.

#!/bin/env python
 
# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
#
# ReadBchFromCool.py  --schema='COOLOFL_TILE/CONDBR2'  --folder='OFL02' --tag='UPD4'
# Sanya Solodkov 2011-07-15
# change: Yuri Smirnov 2015-08-29, correction for EB* modules' nbad counter
 
import getopt,sys,os
os.environ['TERM'] = 'linux'
 
def usage():
    print ("Usage: ",sys.argv[0]," [OPTION] ... ")
    print ("Dumps the TileCal status bits from various schemas / folders")
    print ("")
    print ("-h, --help      shows this help")
    print ("-f, --folder=   specify status folder to use ONL01 or OFL02, don't need to specify full path")
    print ("-t, --tag=      specify tag to use, f.i. UPD1 or UPD4 or full suffix like RUN2-HLT-UPD1-00")
    print ("-r, --run=      specify run  number, by default uses latest iov")
    print ("-l, --lumi=     specify lumi block number, default is 0")
    print ("-b, --begin=    specify run number of first iov in multi-iov mode, by default uses very first iov")
    print ("-e, --end=      specify run number of last iov in multi-iov mode, by default uses latest iov")
    print ("-m, --module=   specify module to use, default is not set")
    print ("-N, --chmin=    specify minimal channel to use, default is 0")
    print ("-X, --chmax=    specify maximal channel to use, default is 47")
    print ("-c, --chan=     specify channel to use , default is all channels from chmin to chmax")
    print ("-g, --gain=, -a, --adc=  specify adc(gain) to use, default is 2 (i.e. both low and high gains)")
    print ("-C, --comment   print comment for every IOV")
    print ("-i, --iov       print IOVs only for every module")
    print ("-I, --IOV       print IOVs only")
    print ("-d, --default   print also default values stored in AUX01-AUX20")
    print ("-B, --blob      print additional blob info")
    print ("-H, --hex       print frag id instead of module name")
    print ("-P, --pmt       print pmt number in addition to channel number")
    print ("-s, --schema=   specify schema to use, like 'COOLOFL_TILE/CONDBR2' or 'sqlite://;schema=tileSqlite.db;dbname=CONDBR2' or tileSqlite.db")
    print ("-D, --dbname=   specify dbname part of schema if schema only contains file name, default is CONDBR2")
    print ("-S, --server=   specify server - ORACLE or FRONTIER, default is FRONTIER")
    print ("-w, --warning   suppress warning messages about missing drawers in DB")
 
letters = "hr:l:s:t:f:D:S:dBHPwm:b:e:a:g:c:N:X:CiI"
keywords = ["help","run=","lumi=","schema=","tag=","folder=","dbname=","server=","default","blob","hex","pmt","warning","module=","begin=","end=","chmin=","chmax=","gain=","adc=","chan=","comment","iov","IOV"]
 
try:
    opts, extraparams = getopt.getopt(sys.argv[1:],letters,keywords)
except getopt.GetoptError as err:
    print (str(err))
    usage()
    sys.exit(2)
 
# defaults
run = 2147483647
lumi = 0
schema = 'COOLOFL_TILE/CONDBR2'
dbname = ''
server = ''
folderPath =  "/TILE/OFL02/STATUS/ADC"
tag = "UPD4"
rosmin = 1
rosmax = 5
blob = False
hexid = False
pmt = False
warn = 1
modmin = 0
modmax = 99999
modulename="AUX-1"
partname=""
one_mod = False
mod = -1
ros = -1
chan_n= -1
chanmin = -1
chanmax = -1
gain_n = -1
gainmin = -1
gainmax = -1
begin = -1
end = 2147483647
iov = False
iovonly = False
IOVONLY = False
comment = False
 
for o, a in opts:
    a = a.strip()
    if o in ("-f","--folder"):
        if '/TILE' in a:
            folderPath = a
        else:
            folderPath = "/TILE/%s/STATUS/ADC" % a
    elif o in ("-t","--tag"):
        tag = a
    elif o in ("-s","--schema"):
        schema = a
    elif o in ("-D","--dbname"):
        dbname = a
    elif o in ("-S","--server"):
        server = a
    elif o in ("-r","--run"):
        run = int(a)
    elif o in ("-l","--lumi"):
        lumi = int(a)
    elif o in ("-b","--begin"):
        begin = int(a)
        iov = True
        one_mod = True
    elif o in ("-e","--end"):
        end = int(a)
        iov = True
        one_mod = True
    elif o in ("-i","--iov"):
        iov = True
        iovonly = True
        if modulename=='AUX-1':
            modulename='ALL00'
    elif o in ("-I","--IOV"):
        iov = True
        IOVONLY = True
        if modulename=='AUX-1':
            modulename='ALL00'
    elif o in ("-a","--adc","-g","--gain"):
        gain_n = int(a)
    elif o in ("-m","--module"):
        modulename = a
        one_mod = True
    elif o in ("-c","--chan"):
        chan_n = int(a)
    elif o in ("-N","--chmin"):
        chanmin = int(a)
    elif o in ("-X","--chmax"):
        chanmax = int(a)
    elif o in ("-C","--comment"):
        comment = True
    elif o in ("-d","--default"):
        rosmin = 0
    elif o in ("-B","--blob"):
        blob = True
    elif o in ("-H","--hex"):
        hexid = True
    elif o in ("-P","--pmt"):
        pmt = True
    elif o in ("-w","--warning"):
        warn = -1
    elif o in ("-h","--help"):
        usage()
        sys.exit(2)
    else:
        raise RuntimeError("unhandled option")
 
 
from TileCalibBlobPython import TileCalibTools
from TileCalibBlobPython import TileBchTools
from TileCalibBlobPython.TileCalibTools import MAXRUN, MAXLBK
from TileCalibBlobObjs.Classes import TileCalibUtils
 
from TileCalibBlobPython.TileCalibLogger import getLogger
log = getLogger("ReadBch")
import logging
logLevel=logging.DEBUG
log.setLevel(logLevel)
log1 = getLogger("TileCalibTools")
log1.setLevel(logLevel)
 
 
#=== check parameters
if len(dbname)<7 and run!=2147483647:
    dbname = 'COMP200' if run<232000 else 'CONDBR2'
 
if 'COOLO' not in schema and ':' not in schema and ';' not in schema:
    schema='sqlite://;schema='+schema+';dbname='+(dbname if len(dbname) else 'CONDBR2')
 
if 'sqlite:' not in schema and len(dbname):
    schema=schema.replace('CONDBR2',dbname)
    schema=schema.replace('COMP200',dbname)
 
if len(tag)==0:
    folderPath='/TILE/ONL01/STATUS/ADC'
    if 'COOLOFL' in schema:
        if 'COMP200' in schema:
            schema='COOLONL_TILE/COMP200'
        if 'CONDBR2' in schema:
            schema='COOLONL_TILE/CONDBR2'
    log.warning("tag is empty, using %s folder and schema %s", folderPath,schema)
 
if schema=='COOLONL_TILE/COMP200':
    if folderPath!="/TILE/ONL01/STATUS/ADC" and folderPath!="/TILE/OFL01/STATUS/ADC":
        log.warning("Folder %s doesn't exist in schema %s", folderPath,schema)
        folderPath="/TILE/ONL01/STATUS/ADC"
        log.warning("Changing folder to %s", folderPath)
 
if schema=='COOLONL_TILE/CONDBR2':
    if folderPath!="/TILE/ONL01/STATUS/ADC":
        log.warning("Folder %s doesn't exist in schema %s ", folderPath,schema)
        folderPath="/TILE/ONL01/STATUS/ADC"
        log.warning("Changing folder to %s", folderPath)
 
if schema=='COOLOFL_TILE/COMP200' or schema=='COOLOFL_TILE/CONDBR2':
    if folderPath!="/TILE/OFL02/STATUS/ADC":
        log.warning("Folder %s doesn't exist in schema %s ", folderPath,schema)
        folderPath="/TILE/OFL02/STATUS/ADC"
        log.warning("Changing folder to %s", folderPath)
 
 
#=== set database
db = TileCalibTools.openDbConn(schema,server)
folderTag = TileCalibTools.getFolderTag(db if 'CONDBR2' in schema else schema, folderPath, tag)
log.info("Initializing folder %s with tag %s", folderPath, folderTag)
 
#=== create bad channel manager
mgr = TileBchTools.TileBchMgr()
mgr.setLogLvl(logLevel)
mgr.initialize(db, folderPath, folderTag, (run,lumi), warn, -2)
if iov or comment or warn<0:
    blobReader = TileCalibTools.TileBlobReader(db,folderPath,folderTag)
 
#=== Dump the current isBad definition
isBadDef = mgr.getAdcProblems(0, TileCalibUtils.definitions_draweridx(), TileCalibUtils.bad_definition_chan(), 0)
if len(list(isBadDef.keys())):
    log.info( "isBad Definition: " )
    for prbCode in sorted(isBadDef.keys()):
        prbDesc = isBadDef[prbCode]
        msg = "- %2i (%s)" % (prbCode,prbDesc)
        log.info( msg )
#=== Dump the current isBadTiming definition
isBadTimingDef = mgr.getAdcProblems(0, TileCalibUtils.definitions_draweridx(), TileCalibUtils.badtiming_definition_chan(), 0)
if len(list(isBadTimingDef.keys())):
    log.info( "isBadTiming Definition: " )
    for prbCode in sorted(isBadTimingDef.keys()):
        prbDesc = isBadTimingDef[prbCode]
        msg = "- %2i (%s)" % (prbCode,prbDesc)
        log.info( msg )
 
 
#=== check ROS and module numbers
if one_mod:
    partname = modulename[:3]
    mod = int(modulename[3:]) -1
 
part_dict = {'AUX':0,'LBA':1,'LBC':2,'EBA':3,'EBC':4}
if partname in part_dict:
    ros = part_dict[partname]
    rosmin = ros
    rosmax = ros+1
else:
    ros = -1
 
if mod >= 0:
    modmin = mod
    modmax = mod+1
elif mod < -1:
    modmax = modmin
 
if chan_n >= 0 and chan_n < TileCalibUtils.max_chan():
    chanmin = chan_n
    chanmax = chan_n+1
else:
    if chanmin<0:
        chanmin = 0
    if chanmax<0:
        chanmax = TileCalibUtils.max_chan()
    else:
        chanmax += 1
 
if gain_n >= 0 and gain_n < TileCalibUtils.max_gain():
    gainmin = gain_n
    gainmax = gain_n+1
else:
    gainmin = 0
    gainmax = TileCalibUtils.max_gain()
 
 
#=== IOV only option
if iovonly or IOVONLY:
    if iovonly:
        print("")
    if begin<0:
        begin = end
    lastRun = -1
    allsince = {}
    roslist = list(range(rosmin,rosmax))
    if comment:
        roslist += [-1]
    for ros in roslist:
        if ros==-1:
            modlist = [1000]
            modName = "Comment"
        else:
            modlist=range(modmin, min(modmax,TileCalibUtils.getMaxDrawer(ros)))
        for mod in modlist:
            if mod<1000:
                if hexid:
                    modName = "0x%x" % ((ros<<8)+mod)
                else:
                    modName = TileCalibUtils.getDrawerString(ros,mod)
            iovs = ["None"]
            dbobjs = blobReader.getDBobjsWithinRange(ros,mod)
            while dbobjs.goToNext():
                obj = dbobjs.currentRef()
                objsince = obj.since()
                sinceRun = objsince >> 32
                sinceLum = objsince & 0xFFFFFFFF
                since    = "(%d,%d)" % (sinceRun, sinceLum)
                if sinceRun>lastRun:
                    lastRun = sinceRun
                if sinceRun>=begin:
                    if iovs[0]!="None":
                        iovs += [since]
                    else:
                        iovs[0] = since
                    if since in allsince:
                        allsince[since] += [modName]
                    else:
                        allsince[since] = [modName]
                else:
                    iovs[0] = since
            if iovonly:
                print("%s %s" % (modName, " ".join(iovs)) )
    if IOVONLY:
        print("")
        all=[]
        for since in allsince:
            if comment and allsince[since][-1]!="Comment":
                allsince[since] += ["NO_COMMENT"]
            all+=["%s %s" % (since," ".join(allsince[since]))]
        if len(all)>0:
            all.sort()
            for s in all:
                print(s)
        else:
            print("No new IOVs after run",lastRun)
    #=== close DB
    db.closeDatabase()
    sys.exit(0)
 
 
#=== Filling the iovList
iovList = []
if iov:
    if mod>=0:
        COOL_part = ros
        COOL_chan = mod
    else:
        COOL_part = -1
        COOL_chan = 1000
 
    try:
        dbobjs = blobReader.getDBobjsWithinRange(COOL_part,COOL_chan)
        if (dbobjs is None):
            raise Exception("No DB objects retrieved when building IOV list!")
        while dbobjs.goToNext():
            obj = dbobjs.currentRef()
            objsince = obj.since()
            sinceRun = objsince >> 32
            sinceLum = objsince & 0xFFFFFFFF
            since    = (sinceRun, sinceLum)
            objuntil = obj.until()
            untilRun = objuntil >> 32
            untilLum = objuntil & 0xFFFFFFFF
            until    = (untilRun, untilLum)
            iovList.append((since, until))
    except Exception:
        log.warning( "Warning: can not read IOVs from input DB file" )
        sys.exit(2)
 
    be=iovList[0][0][0]
    en=iovList[-1][0][0]
 
    if begin != be or end != en:
        ib=0
        ie=len(iovList)
        for i,iovs in enumerate(iovList):
            run = iovs[0][0]
            lumi = iovs[0][1]
            if (run<begin and run>be) or run==begin :
                be=run
                ib=i
            if run>=end and run<en:
                en=run
                ie=i+1
        log.info( "" )
        if be != begin:
            log.info( "Changing begin run from %d to %d (start of IOV)", begin,be)
            begin=be
        if en != end:
            if en>end:
                log.info( "Changing end run from %d to %d (start of next IOV)", end,en)
            else:
                log.info( "Changing end run from %d to %d (start of last IOV)", end,en)
            end=en
        iovList=iovList[ib:ie]
        if COOL_chan == 1000:
            log.info( "%d IOVs in total for comment field", len(iovList) )
        else:
            log.info( "%d IOVs in total for %s", len(iovList),modulename)
else:
    iovList.append(((run,lumi),(MAXRUN, MAXLBK)))
 
log.info( "\n" )
 
 
 
dummy = [0]*48
barrel = [ 1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12,
          13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
          27, 26, 25, 30, 29, 28,-33,-32, 31, 36, 35, 34,
          39, 38, 37, 42, 41, 40, 45,-44, 43, 48, 47, 46]
extbar = [ 1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12,
          13, 14, 15, 16, 17, 18,-19,-20, 21, 22, 23, 24,
         -27,-26,-25,-31,-32,-28, 33, 29, 30,-36,-35, 34,
          44, 38, 37, 43, 42, 41,-45,-39,-40,-48,-47,-46]
 
ch2pmt = [ dummy, barrel, barrel, extbar, extbar ]
gname = [ "LG", "HG" ]
 
#=== Get ADC problems
 
#=== get the channel status (if it is bad and will be masked)
#=== the channel status depends on the definition of isBad stored
#=== in the database drawer 1, channel 0
#=== isAffected = has a problem not included in isBad definition
#=== isGood = has no problem at all
 
pref = ""
for iovs in iovList:
    if iov:
        pref = "(%i,%i)  " % (iovs[0][0],iovs[0][1])
    if comment:
        log.info( pref + blobReader.getComment(iovs[0]) )
    modOk = False
    miss  = 0
    good  = 0
    aff   = 0
    bad   = 0
    nMod  = 0
    for ros in range(rosmin,rosmax):
        for mod in range(modmin, min(modmax,TileCalibUtils.getMaxDrawer(ros))):
            nMod += 1
            mgr.updateFromDb(db, folderPath, folderTag, iovs[0], 1, warn, ros, mod)
            if hexid:
                modName = "0x%x" % ((ros<<8)+mod)
            else:
                modName = TileCalibUtils.getDrawerString(ros,mod)
            if warn<0:
                bch = blobReader.getDrawer(ros, mod, iovs[0], False, False)
                if bch is None:
                    modOk = False
                    miss+=1
                    #print ("%s is missing in DB" % modName)
                else:
                    modOk = True
                    if blob and bch:
                        print ("%s  Blob type: %d  Version: %d  Nchannels: %d  Ngains: %d  Nval: %d" % (modName, bch.getObjType(), bch.getObjVersion(), bch.getNChans(), bch.getNGains(), bch.getObjSizeUint32()))
            nBad=0
            for chn in range(chanmin,chanmax):
                chnName = " %2i" % chn
                for adc in range(gainmin,gainmax):
 
                    stat = mgr.getAdcStatus(ros,mod,chn,adc)
                    #log.info( "- ADC status = isBad:      %d" % stat.isBad()      )
                    #log.info( "- ADC status = isGood:     %d" % stat.isGood()     )
                    #log.info( "- ADC status = isAffected: %d" % stat.isAffected() )
 
                    #=== get all problems of the channel
                    prbs = mgr.getAdcProblems(ros,mod,chn,adc)
                    #log.info( "ADC Problems: " )
                    if len(prbs) or iov:
                        modOk = False
                        if pmt:
                            msg = "%s pm %02i ch %02i %s " % ( modName, abs(ch2pmt[ros][chn]), chn, gname[adc] )
                        else:
                            msg = "%s %2i %1i " % ( modName,chn,adc )
                        for prbCode in sorted(prbs.keys()):
                            prbDesc = prbs[prbCode]
                            msg += " %5i (%s)" % (prbCode,prbDesc)
                        if stat.isBad():
                            msg += "  => BAD"
                            nBad+=1
                        elif stat.isAffected():
                            msg += "  => Affected"
                        elif stat.isGood():
                            msg += "  => good"
                        print (pref+msg)
            if modOk:
                good+=1
                print ("%s ALL GOOD" % (modName))
            elif nBad==0:
                aff+=1
            elif nBad==TileCalibUtils.max_gain()*TileCalibUtils.max_chan() or (nBad==90 and 'LB' in modName) or (nBad==64 and 'EB'in modName) or (nBad==60 and 'EBA15' in modName) or (nBad==60 and 'EBC18' in modName):
                bad+=1
    if warn<0:
        if miss:
            print ("%3i drawers are missing in DB" % miss)
        print ("%3i drawers are absolutely good" % good)
        print ("%3i drawers have good and affected channels" % (aff-miss))
        print ("%3i drawers have some bad channels" % (nMod-good-bad-aff))
        print ("%3i drawers are completely bad" % bad)
    #=== print all bad channels
    #log.info("listing bad channels")
    #mgr.listBadAdcs()
 
#=== close DB
db.closeDatabase()