testAppLDFdump.py

#!/usr/local/bin/python
#
#                               Copyright 2003
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "Example EBF event handling test application"
__author__   = "R. Claus <Claus@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2/25/2003"
__version__  = "$Revision: 1.3 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

import threading
import logging       as     log

from   LATTE.runcontrol.rcTransitions import rcTransitions
from   LATTE.runcontrol.ArgumentImpl  import ArgumentImpl

from support.SimpleGasuExample   import *
from support.MiniGLTExample      import *

import LDF
import LDFdumper as LD

class LATcomponentIterator(LD.LATcomponentIterator):
  def __init__(self):
    LDF.LATcomponentIterator.__init__(self)
    self.__calSrc                  = None
    self.__tkrContributionIterator = None
    print "LATcomponentIterator.__init__"

  def UDFcomponent(self, event, ebfContribution):
    print ""
    print "Undefined EBF component"
    LD.EBFcontribution(event, ebfContribution).dumpCommon("  ")
    LD.EBFcontribution(event, ebfContribution).dump("  ")
    return 0

  def OSWcomponent(self, event, oswContribution):
    # Assuming this is always the first component seen, dump the event
    print ""
    LD.EBFevent(event).dump()
    print ""
    print "OSW:"
    LD.EBFcontribution(event, oswContribution).dumpCommon("  ")
    oswContribIter = LD.OSWcontributionIterator(event, oswContribution)
    print "  OSW:"
    oswContribIter.dump("  ")
    return 0

  def GLTcomponent(self, event, gltContribution):
    print ""
    print "GLT:"
    LD.EBFcontribution(event, gltContribution).dumpCommon("  ")
    LD.GLTcontribution(event, gltContribution).dump("  ")
    return 0

  def GEMcomponent(self, event, gemContribution):
    print ""
    print "GEM:"
    LD.EBFcontribution(event, gemContribution).dumpCommon("  ")
    LD.GEMcontribution(event, gemContribution).dump("  ")
    return 0

  def ACDcomponent(self, event, aemContribution):
    print ""
    print "AEM:"
    LD.EBFcontribution(event, aemContribution).dumpCommon("  ")
    aemContribIter = LD.AEMcontributionIterator(event, aemContribution)
    print "  ACD:"
    aemContribIter.dump("  ")
    return 0

  def CALcomponent(self, event, calContribution):
    self.__calSrc = LD.LATPcellHeader.source(calContribution.header())
    print ""
    print "TEM %2d:" % (self.__calSrc)
    LD.EBFcontribution(event, calContribution).dumpCommon("  ")
    calContribIter = LD.CALcontributionIterator(event,calContribution)
    calContribIter.dump("  ")
    self.CALend(calContribIter.CALend())
    return 0

  def TKRcomponent(self, event, tkrContribution):
    if self.__calSrc != LD.LATPcellHeader.source(tkrContribution.header()):
      print ""
      print "TEM %2d:" % (LD.LATPcellHeader.source(tkrContribution.header()))
      LD.EBFcontribution(event, tkrContribution).dumpCommon("  ")
    tkrContribIter = LD.TKRcontributionIterator(event, tkrContribution)
    tkrContribIter.dump("  ")
    self.__tkrContributionIterator = tkrContribIter
    if tkrContribIter.diagnostic() is not None:
      self.TKRend(tkrContribIter.diagnostic())
    return 0

#  This class puts up a GUI for inputting a value of some sort.  It is used by
#  the userApplication example to get the number of self triggers to take.
class userArgument(ArgumentImpl):
  "GUI for getting the user to input some sort of value."
  def __init__(self, parent = None, name = None, modal = 0, fl = 0):
    ArgumentImpl.__init__(self, parent, name, modal, fl)
    self.__value = 0
    self.setCaption("Hello world!")

  def OKButtonClicked(self):
    self.__value = int(self.ArgumentList.text().latin1())
    self.close()

  def getValue(self, caption):
    self.setCaption(caption)
    self.show()
    self.exec_loop()
    return self.__value

class userArgText(object):
  "Text user interface for getting the user to input some sort of value"
  def __init__(self):
    pass

  def getValue(self, caption):
    return int(raw_input("%s: " % (caption)))


#  Example application implementation.
#  Note that the name of the class must be userApplication.
#  Look at rcTransitions for names of other transition methods that can be used.
class userApplication(rcTransitions):
  "Implmentation class for a user application"
  def __init__(self, gui, userId, debug):
    rcTransitions.__init__(self, gui, userId, debug)
    log.debug("userApplication.__init__()")
    self.__eventSem    = threading.Semaphore(0)
    self.__cmdSynchSem = threading.Semaphore(0)
    self.__lci         = LATcomponentIterator()
    self.__ldbi        = LDF.LATdataBufferIterator(self.__lci)

  def getName(self):
    return __name__

  def setup(self):
    log.debug("userApplication.setup()")

    if self.rc is None:
      self.__arg = userArgText()
    else:
      self.__arg = self.rc.createGUI(userArgument, self.rc, 'test1', 1)

    # Get a TEM instance
    if self.lat.TEMcnt() == 1:
      tem = self.lat.TEM[self.lat.TEM.keys()[0]]
    elif self.lat.TEMcnt() > 1:
      tem = self.lat.TEM.all()
    else:
      log.fatal("No TEM(s) found in the schema")
      return -1

    # reset the TEM since we are going to modify DATA_MASKS
    tem.CMD_RESET = 1

    # clear TEM stats reg
    tem.COMMAND_RESPONSE = 0

    # clear TEM status reg
    tem.STATUS = 0

    # enable CAL, disable TKR, no diag #  0x10FF for diag
    tem.DATA_MASKS = 0x00FF

    # TEM config reg # set TEM timeout
    tem.CONFIGURATION = 0

    #status = gTEMread( __GT, temId, TEM_REG_CONFIGURATION, &payload);
    #printf("tem config reg = 0x%08x\n", payload);

    # enable output in our GCCCs
    # broadcast load of GCCC_REG_CONFIGURATION

    bcast_ccc = tem.allCCC()
    bcast_ccc.CONFIGURATION = 0x80000000L

    #  disable all GCRCs in all GCCCs via broadcast # GCCC_REG_LAYER_MASK_0, GCCC_REG_LAYER_MASK_1
    bcast_ccc.LAYER_MASK_0 = 0xFFFFFFFFL
    bcast_ccc.LAYER_MASK_1 = 0xFFFFFFFFL
    ccc2 = tem.downCCC(2) # O$GCCC_02
    ccc2.LAYER_MASK_1 = 0x3BFD3FFF

    # large timeouts for all GCCCs
    # broadcast load of GCCC_REG_EVENT_TIMEOUTS
    bcast_ccc.EVENT_TIMEOUTS = 0x0
    #status = gGCCCread( __GT, temId, 1, GCCC_REG_EVENT_TIMEOUTS, &payload);
    #printf("gccc register event timeouts = 0x%08x\n", payload);

    # Two choices for the trigger, GEM and MiniGLT
    if self.lat.existsGEM():
      self.trigger( SimpleGasuExample() )
    else:
      self.trigger( MiniGLTExample() )

    # A state transition can be rejected by not returning None
    return None

  def startRun(self):
    log.debug("userApplication.startRun()")

    caption = "Enter number of triggers to take"
    if self.rc is None:
      cnt = self.__arg.getValue(caption)
    else:
      cnt = self.rc.execGUImethod(self.__arg.getValue, caption)

    # The user pressed 'Cancel'
    if cnt is None:  return -1
    self.__cnt = cnt

    # Spawn a thread to synchronize commands with events
    # This must happen after triggers are enabled
    self.__cmdSynchQuit = False

    # A state transition can be rejected by not returning None
    return None

  def stopRun(self):
    self.setCompletionStatus(self.COMPL_STATUS_SUCCESS)
    self.__cmdSynchQuit = True
    self.__eventSem.release()

    # The STOP_RUN transition can not be rejected

  def resume(self):
    # Issue self trigger to make up for the one that was lost during PAUSE
    self.trigger().solicit()

    return None

  def stop(self):
    return self.stopRun()

  def process(self, (status, buffer)):
    "Method called back for each data event taken"
    ###log.debug("userApplication.process()")

    evtCli = self.evtCli

    if status != 0:
      if evtCli.isGGLTStatus():
        log.error("GGLT_STATUS=%d %s" % (evtCli.getGGLTStatus(), evtCli.getGGLTStatusStr()))
      elif not evtCli.checkOnlineStatus(status, self.evtCli.PLAYBACK_ERROR):
        log.error("EVENT ERROR= 0x%x %s" % (status, evtCli.getOnlineStatusStr()))
      self.__eventSem.release()
      return

    try:
      # In the future this event may contain additional data
      if evtCli.isSweepEvent(): return
    except:
      # Event summary word inaccessible, handle the bad event here
      import gutil
      gutil.logException()
      return

    self.__ldbi.iterate(buffer, len(buffer))

    # Get next event triggered
    self.__eventSem.release()

  def commandSynch(self):
    "Method called by the command synchronization task"
    import time
    trigger  = self.trigger()
    eventSem = self.__eventSem

    # Drain the semaphore release count
    # Handles the case when the stop run release collided with a trigger release
    while eventSem.acquire(0):  pass

    t0  = time.time()

    # Compensate for the extra CMD_SELF_TRIGGER below
    cnt   = 1
    count = self.__cnt

    # Wait for START_RUN to enable triggers
    trigger.waitForMaskEnable()

    trigger.solicit()                   # Issue an internal trigger
    eventSem.acquire()                  # Wait for the event to be processed

    t1 = trigger.getEnableTime()        # get the last trigger enable time from GLT

    while cnt < count and not self.__cmdSynchQuit:
      cnt += 1
      trigger.solicit()                 # Issue an internal trigger
      time.sleep(.0001)
      eventSem.acquire()                # Wait for the event to be processed
      #trigger.disable()                # Disable triggers
      # Do stuff
      #trigger.enable()                 # Enable triggers

    t2 = trigger.getTimeStamp()         # Get the last trigger timestamp

    if t1 is None:
      t1 = t0
    if t2 is None:
      t2 = time.time()
    dT = t2 - t1
    if dT == 0.0:  dT = 0.000001
    log.info("%s processed %d events in %.3f seconds = %.1f events/second" % \
             (self.getName(), self.evtCnt, dT, self.evtCnt/dT))

    # Get out of waiting when in standalone mode
    self.sync()

    # execute the GUI functions for stopRun, just in case
    if not self.__cmdSynchQuit and not self.isRunFromSuite():
      if self.gui is not None:
        self.gui.doStopRun()

  def wait(self):
    self.__cmdSynchSem.acquire()

  def sync(self):
    if __name__ == "__main__" or self.isRunFromSuite():
      self.__cmdSynchSem.release()


# Standalone mode:
if __name__ == "__main__":
  import os
  log.basicConfig()
  log.getLogger("").setLevel(log.DEBUG)
  ua = userApplication(None, 321, 1)
  ua.rcSetup(os.path.join(os.environ['ONLINE_ROOT'], 'repos/simpleTemSchema.xml'))
  ua.rcStartRun()
  ua.wait()
  ua.rcStopRun()
  ua.rcTeardown()

# History:
#     $Log: testAppLDFdump.py,v $
#     Revision 1.3  2006/04/05 15:40:30  perazzo
#     LDFdumper is now in PYTHONPATH
#
#     Revision 1.2  2005/03/21 17:58:13  claus
#     Modified to use the first TEM found in the schema, if only one is there, or
#     broadcast to all TEMs if there are multiple.
#
#     Revision 1.1  2004/08/18 18:00:15  stuvi
#     Updated for LATTE 4.
#     All hippo functions go through the Qt GUI bridge now.
#
#     Revision 1.3  2004/05/03 21:19:47  stuvi
#     Moved non-Runcontrol scripts to the support directory and modified imports accordingly.
#
#     Revision 1.2  2004/04/02 23:57:53  claus
#     xxxComponent methods must return a status value.
#
#     Revision 1.1  2004/04/02 22:31:46  claus
#     Event dumper using the LDF library and the new LATdataBufferIterator class.
#
#     Revision 1.8  2004/03/10 22:24:51  panetta
#     Upgraded trigger interface.
#     Removed dependencies on self.glt.
#
#     Revision 1.7  2003/11/04 18:30:53  panetta
#     Changed the commandSynch logic so that the enableMask() call would not pose a threat to snapshot taking.
#
#     Revision 1.6  2003/10/31 01:09:37  panetta
#     1)  Moved register writes from startRun to setup
#     2)  Added GLT enabling logic to __commandSynch
#     3)  Gave example of getting the start/stop time from the hardware/event stream
#
#     Revision 1.5  2003/06/13 23:26:24  stuvi
#     Added TEM reset
#
#     Revision 1.4  2003/04/01 21:04:59  stuvi
#     Fixed event count discrepancy when the run is stopped in the middle.
#
#     Revision 1.3  2003/03/26 21:59:36  stuvi
#     Fixed standalone mode
#
#     Revision 1.2  2003/03/13 00:06:34  claus
#     Interface changes plus diagnostic and error dumps
#
#     Revision 1.1  2003/03/10 21:49:56  claus
#     RunControl example of an event dumper
#
#

---