LATfileTools.py

Go to the documentation of this file.

#!/usr/local/bin/python
#
# package LATfileTools.py
#
# This package creates an interface to adding specific LAT types of file to
#    the system.  
#
# LAT types of file include:
#   LATC blobs  (creation, etc)
#   LCI  blobs
#


__facility__ = "Online"
__abstract__ = "LAT level File tools for ScriptEngine classes"
__author__   = "J. Panetta <panetta@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/11/1 00:08:27"
__updated__  = "$Date: 2006/01/03 19:42:08 $"
__version__  = "$Revision: 1.2 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

import LICOS.tests.lib.fileTools      as fileTools
import LICOS.tools.LATc.latte2latcXML as latte2latcXML

import logging as log
import time
import os
import struct
from tempfile import NamedTemporaryFile

LATC_PARSE_COMMAND = 'LATC_parser'    # for now, assume it is in path?
LATC_DEVICE        = fileTools.FSW_DEVICE_RAM
LATC_DIR           = fileTools.INT_DIR_LATC


def convertSnapshotToLatcBlob(snapshot, purge=False):
  """!\brief Convert a disk-resident LAT snapshot to a set of LATC blobs

  \return the set [master, [blobs]] as FswFile objects suitable for upload
  """

  xmlList = convertSnapshotToLatcXML(snapshot, purge)

  blobSet = convertLatcXMLtoBlob(xmlList, purge)

  master  = makeLatcMasterFromBlobs(blobSet)


  return [master, blobSet]

def convertSnapshotToLatcXML(snapshot):
  """!\brief Convert a disk-resident LAT snapshot to a set of LATC XML files

  \param   snapshot    A LATTE4 snapshot
  \return  List of xml file objects (already opened)
  """
  
  converter = latte2latcXML.latte2latcXML(latte2latcXML.LATTE2LATC_CONFIG,
                                          latte2latcXML.LATCREGATTR_CONFIG)

  log.debug( "reading LATTE xml")
  glatDOC    = converter.readLatteXML(snapshot)     # ~20 seconds

  log.debug( "converting to LATC")
  # straight 1:1 conversion btwn snapshot and LATC xml
  latcRawDOC = converter.makeLatcDOC(glatDOC)

  log.debug( "Building broadcast nodes")
  # Compute node statistics for building broadcast
  converter.computeNodeModes(converter.getLATC(latcRawDOC))

  # Create broadcast xml as a temp file
  bcast = converter.buildLatcBcast()
  bcastFile  = NamedTemporaryFile(mode='w+b')   
  converter.writeLatcXML(id='bcast', file=bcastFile.name)

  purged = converter.purgeBcast(latcRawDOC, bcast)

  # don't bother with the split, just return the non bcast nodes as a monolith
  singlesFile = NamedTemporaryFile(mode='w+b')
  converter.writeLatcXML(id='base', file=singlesFile.name)

  return [bcastFile, singlesFile]


def convertLatcXMLtoBlob(xmlList):
  """!\brief Convert a disk-resident LAT snapshot to a set of LATC blobs

  \param   xmlList  List of xml file objects  
  \return  List of created FSW file objects
  """

  log.debug('Converting to blobs')
  # create comma separated list of filenames
  fileNames = [ f.name for f in xmlList ]
  fileListStr = ','.join(fileNames)

  outputStub = os.path.join(fileTools.FILETOOL_TMP_PATH, 'tmpLatcXML')
  __clearBlobs(outputStub)

  # dispatch latc parse command
  cmd  = LATC_PARSE_COMMAND
  cmd += ' -i=%s' % fileListStr
  cmd += ' -o=%s' % outputStub
  

  rc = os.system(cmd)
  if rc != 0:
    raise RuntimeError("Failure of system command %s" % cmd)

  log.debug('adding headers')
  # grab latc xml files from disk
  outputDir, outputHead  = os.path.split(outputStub)
  fmxList = []

  for f in os.listdir(outputDir):
    if f[:len(outputHead)] == outputHead:
      tmp = fileTools.FswFileFromDisk( fileTools.FswFileID( LATC_DEVICE, LATC_DIR, fileTools.arbitraryFileID()), 
                                       os.path.join(outputDir, f) )
      tmp2 = fileTools.addFmxHeader(tmp, name=f, key=fileTools.arbitraryFmxID())
      fmxList.append( tmp2 )
      
  
  return fmxList
  
def makeLatcMasterFromBlobs(blobSet):
  """!\brief Create the LATC master file from a set of blobs
  """
  masterBin = ''
  for fmxFile in blobSet:
    print 'adding fileID %x to master' % fmxFile.fileID().id()
    masterBin += struct.pack('!L', fmxFile.fileID().id())

  tmp = fileTools.FswFileFromData( fileTools.FswFileID( LATC_DEVICE, LATC_DIR, fileTools.arbitraryFileID()),
                                   masterBin )
  masterFile = fileTools.addFmxHeader( tmp, name='LCMASTER', key=fileTools.arbitraryFmxID()) 

  return masterFile


def __clearBlobs(outputStub):
  """!\brief clear out all the latc blobs from the output stub area
  
  """

  dir,stub = os.path.split(outputStub)
  if stub == '': return
  for f in os.listdir(dir):
    if f[:len(stub)] == stub:
      os.remove(os.path.join(dir,f))

---