testErrorPropogation.py

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

__facility__ = "Online"
__abstract__ = "Test application for inducing and detecting event errors"
__author__   = "J. Panetta <panetta@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/03/22"
__version__  = "$Revision: 1.2 $"
__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 *


#  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 CancelButtonClicked(self):
    self.__value = None
    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)
    
  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)

    # 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
    
    if self.rc is not None:
      self.getParameterVerifier().add(caption, cnt)
      
    # Spawn a thread to synchronize commands with events
    # This must happen after triggers are enabled
    self.__cmdSynchQuit = False

    # turn on the prescaler to infinite:
    self.ocs.evtHandlerSendPrescaled(-1)    
    
    # A state transition can be rejected by not returning None
    return None

  def stopRun(self):

    # Success is defined if we found one and only one trigger parity error
    # and one and only one packet error
    if self.getBadEvents() == 0 and self.getErrorEvents() == 0:
      self.setCompletionStatus(self.COMPL_STATUS_PASSED)
    else:
      self.setCompletionStatus(self.COMPL_STATUS_FAILED)

    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:
      print "status = ", status
      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

    if evtCli.isTrgParityErrorEvent():
      log.debug( "Found a trigger parity error")
    elif evtCli.isPacketErrorEvent():
      log.debug( "Found a packet error")
    else:
      log.debug( "Found a normal event")
    # 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

    # bitmask in GEM config to cause trigger parity error
    TPE = 0x20
    # bitmask in GEM config to cause packet error  (suppress bit)
    PKTE = 0x40

    log.info(" commandSync")
    # Wait for START_RUN to enable triggers
    trigger.waitForMaskEnable()

    # Cause a trigger parity error for GEM event
    log.info( "buggering gem configuration to create trigger parity errors")
    trigger.disable()
    gemc = trigger.GEM().GEMC
    gemcfg = gemc.CONFIGURATION
    gemcfg |= TPE
    gemc.configuration = gemcfg
    trigger.enable()

    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

    # Reset the GEM to remove the trigger parity error bit.
    trigger.disable()
    log.info( "unbuggering gem configuration")
    gemc = trigger.GEM().GEMC
    gemcfg = gemc.CONFIGURATION
    gemcfg &= ~TPE
    gemc.configuration = gemcfg

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

             
    # 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()

---