LutXml.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     CaloOnlineTools/HcalOnlineDb
// Class  :     LutXml
//
// Implementation:
//     <Notes on implementation>
//
// Original Author:  Gena Kukartsev, kukarzev@fnal.gov
//         Created:  Tue Mar 18 14:30:20 CDT 2008
//

#include <iostream>
#include <string>
#include <vector>
#include <sstream>
#include <iconv.h>
#include <sys/time.h>

#include "CalibCalorimetry/HcalTPGAlgos/interface/LutXml.h"
#include "CalibCalorimetry/HcalTPGAlgos/interface/XMLProcessor.h"
#include "md5.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "CalibCalorimetry/HcalTPGAlgos/interface/HcalEmap.h"
#include "DataFormats/HcalDetId/interface/HcalDetId.h"
#include "DataFormats/HcalDetId/interface/HcalTrigTowerDetId.h"

using namespace std;
XERCES_CPP_NAMESPACE_USE

LutXml::Config::_Config() {
  infotype = "LUT";
  ieta = -1000;
  iphi = -1000;
  depth = -1;
  crate = -1;
  slot = -1;
  topbottom = -1;
  fiber = -1;
  fiberchan = -1;
  lut_type = -1;
  creationtag = "default_tag";

  char timebuf[50];
  time_t _time = time(nullptr);
  strftime(timebuf, 50, "%Y-%m-%d %H:%M:%S", gmtime(&_time));
  creationstamp = timebuf;

  formatrevision = "default_revision";
  targetfirmware = "default_revision";
  generalizedindex = -1;
  weight = -1;
  // Default to keeping veto disabled
  codedvetothreshold = 0;
}

LutXml::LutXml() : XMLDOMBlock("CFGBrickSet", 1) { init(); }

LutXml::LutXml(InputSource &_source) : XMLDOMBlock(_source) { init(); }

LutXml::LutXml(std::string filename) : XMLDOMBlock(filename) { init(); }

LutXml::~LutXml() {
  XMLString::release(&root);
  XMLString::release(&brick);
}

void LutXml::init(void) {
  root = XMLString::transcode("CFGBrickSet");
  brick = XMLString::transcode("CFGBrick");
  brickElem = nullptr;
}

std::vector<unsigned int> *LutXml::getLutFast(uint32_t det_id) {
  if (lut_map.find(det_id) != lut_map.end())
    return &(lut_map)[det_id];
  edm::LogError("LutXml") << "LUT not found, null pointer is returned";
  return nullptr;
}

// checksums_xml is 0 by default
void LutXml::addLut(LutXml::Config &_config, XMLDOMBlock *checksums_xml) {
  DOMElement *rootElem = document->getDocumentElement();

  brickElem = document->createElement(XMLProcessor::_toXMLCh("CFGBrick"));
  rootElem->appendChild(brickElem);

  addParameter("INFOTYPE", "string", _config.infotype);
  addParameter("CREATIONTAG", "string", _config.creationtag);
  addParameter("CREATIONSTAMP", "string", _config.creationstamp);
  addParameter("FORMATREVISION", "string", _config.formatrevision);
  addParameter("TARGETFIRMWARE", "string", _config.targetfirmware);
  addParameter("GENERALIZEDINDEX", "int", _config.generalizedindex);
  addParameter("CRATE", "int", _config.crate);
  addParameter("SLOT", "int", _config.slot);

  if (checksums_xml) {
    addParameter("CHECKSUM", "string", get_checksum(_config.lut));
  }

  if (_config.lut_type == 1) {  // linearizer LUT
    addParameter("IETA", "int", _config.ieta);
    addParameter("IPHI", "int", _config.iphi);
    addParameter("TOPBOTTOM", "int", _config.topbottom);
    addParameter("LUT_TYPE", "int", _config.lut_type);
    addParameter("FIBER", "int", _config.fiber);
    addParameter("FIBERCHAN", "int", _config.fiberchan);
    addParameter("DEPTH", "int", _config.depth);
    addData(to_string(_config.lut.size()), "hex", _config.lut);
  } else if (_config.lut_type == 2 || _config.lut_type == 4) {  // compression LUT or HE feature bit LUT
    addParameter("IETA", "int", _config.ieta);
    addParameter("IPHI", "int", _config.iphi);
    addParameter("TOPBOTTOM", "int", _config.topbottom);
    addParameter("LUT_TYPE", "int", _config.lut_type);
    addParameter("SLB", "int", _config.fiber);
    addParameter("SLBCHAN", "int", _config.fiberchan);
    addParameter("WEIGHT", "int", _config.weight);
    // Special coded veto threshold value of zero disables vetoing in PFA1'
    if (_config.codedvetothreshold > 0) {
      // A valid coded value here is in the range (1, 2048) inclusive
      if (_config.codedvetothreshold <= 2048) {
        // The coded value of 2048 means to do vetoing with no threshold
        int actualvetothreshold = _config.codedvetothreshold == 2048 ? 0 : _config.codedvetothreshold;
        addParameter("PREFIRE_VETO_THRESHOLD", "int", actualvetothreshold);
      } else {
        edm::LogWarning("LutXml") << "Positive veto threshold of " << _config.codedvetothreshold
                                  << " is not in range (1, 2048) ! Vetoing will not be done in PFA1' !";
      }
    }
    addData(to_string(_config.lut.size()), "hex", _config.lut);
  } else if (_config.lut_type == 5) {  // channel masks
    addParameter("MASK_TYPE", "string", "TRIGGERCHANMASK");
    addData(to_string(_config.mask.size()), "hex", _config.mask);
  } else if (_config.lut_type == 6) {  // adc threshold for tdc mask
    addParameter("THRESH_TYPE", "string", "TRIGINTIME");
    addData(to_string(_config.mask.size()), "hex", _config.mask);
  } else if (_config.lut_type == 7) {  // tdc mask
    addParameter("TDCMAP_TYPE", "string", "TRIGINTIME");
    addData(to_string(_config.mask.size()), "hex", _config.mask);
  } else {
    edm::LogError("LutXml") << "Unknown LUT type...produced XML will be incorrect";
  }

  if (checksums_xml) {
    add_checksum(checksums_xml->getDocument(), _config);
  }
}

template <typename T>
DOMElement *LutXml::addData(std::string _elements, std::string _encoding, const T &_lut) {
  DOMElement *child = document->createElement(XMLProcessor::_toXMLCh("Data"));
  child->setAttribute(XMLProcessor::_toXMLCh("elements"), XMLProcessor::_toXMLCh(_elements));
  child->setAttribute(XMLProcessor::_toXMLCh("encoding"), XMLProcessor::_toXMLCh(_encoding));

  std::stringstream buf;

  for (const auto &iter : _lut) {
    char buf2[16];
    sprintf(buf2, "%lx", uint64_t(iter));
    buf << buf2 << " ";
  }

  std::string _value = buf.str();

  DOMText *data_value = document->createTextNode(XMLProcessor::_toXMLCh(_value));
  child->appendChild(data_value);

  brickElem->appendChild(child);

  return child;
}

DOMElement *LutXml::add_checksum(DOMDocument *parent, Config &config) {
  DOMElement *child = parent->createElement(XMLProcessor::_toXMLCh("Data"));
  child->setAttribute(XMLProcessor::_toXMLCh("crate"), XMLProcessor::_toXMLCh(config.crate));
  child->setAttribute(XMLProcessor::_toXMLCh("slot"), XMLProcessor::_toXMLCh(config.slot));
  child->setAttribute(XMLProcessor::_toXMLCh("fpga"), XMLProcessor::_toXMLCh(config.topbottom));
  child->setAttribute(XMLProcessor::_toXMLCh("fiber"), XMLProcessor::_toXMLCh(config.fiber));
  child->setAttribute(XMLProcessor::_toXMLCh("fiberchan"), XMLProcessor::_toXMLCh(config.fiberchan));
  child->setAttribute(XMLProcessor::_toXMLCh("luttype"), XMLProcessor::_toXMLCh(config.lut_type));
  child->setAttribute(XMLProcessor::_toXMLCh("elements"), XMLProcessor::_toXMLCh("1"));
  child->setAttribute(XMLProcessor::_toXMLCh("encoding"), XMLProcessor::_toXMLCh("hex"));
  DOMText *checksum_value = parent->createTextNode(XMLProcessor::_toXMLCh(get_checksum(config.lut)));
  child->appendChild(checksum_value);

  parent->getDocumentElement()->appendChild(child);

  return child;
}

DOMElement *LutXml::addParameter(std::string _name, std::string _type, std::string _value) {
  DOMElement *child = document->createElement(XMLProcessor::_toXMLCh("Parameter"));
  child->setAttribute(XMLProcessor::_toXMLCh("name"), XMLProcessor::_toXMLCh(_name));
  child->setAttribute(XMLProcessor::_toXMLCh("type"), XMLProcessor::_toXMLCh(_type));
  DOMText *parameter_value = document->createTextNode(XMLProcessor::_toXMLCh(_value));
  child->appendChild(parameter_value);

  brickElem->appendChild(child);

  return child;
}

DOMElement *LutXml::addParameter(std::string _name, std::string _type, int _value) {
  char buf[128];
  sprintf(buf, "%d", _value);
  std::string str_value = buf;
  return addParameter(_name, _type, str_value);
}

std::string &LutXml::getCurrentBrick(void) { return getString(brickElem); }

// do MD5 checksum
std::string LutXml::get_checksum(std::vector<unsigned int> &lut) {
  std::stringstream result;
  md5_state_t md5er;
  md5_byte_t digest[16];
  md5_init(&md5er);
  // linearizer LUT:
  if (lut.size() == 128) {
    unsigned char tool[2];
    for (int i = 0; i < 128; i++) {
      tool[0] = lut[i] & 0xFF;
      tool[1] = (lut[i] >> 8) & 0xFF;
      md5_append(&md5er, tool, 2);
    }
  } else if (lut.size() == 256) {
    unsigned char tool[2];
    for (int i = 0; i < 256; i++) {
      tool[0] = lut[i] & 0xFF;
      tool[1] = (lut[i] >> 8) & 0xFF;
      md5_append(&md5er, tool, 2);
    }
  }
  // compression LUT:
  else if (lut.size() == 1024) {
    unsigned char tool;
    for (int i = 0; i < 1024; i++) {
      tool = lut[i] & 0xFF;
      md5_append(&md5er, &tool, 1);
    }
  } else if (lut.size() == 2048) {
    unsigned char tool;
    for (int i = 0; i < 2048; i++) {
      tool = lut[i] & 0xFF;
      md5_append(&md5er, &tool, 1);
    }
  }
  // HE fine grain LUT
  else if (lut.size() == 4096) {
    unsigned char tool;
    for (int i = 0; i < 4096; i++) {
      tool = lut[i] & 0xFF;
      md5_append(&md5er, &tool, 1);
    }
  } else {
    edm::LogError("LutXml") << "Irregular LUT size, " << lut.size()
                            << " , do not know how to compute checksum, exiting...";
    exit(-1);
  }
  md5_finish(&md5er, digest);
  for (int i = 0; i < 16; i++)
    result << std::hex << (((int)(digest[i])) & 0xFF);

  return result.str();
}

int LutXml::test_access(std::string filename) {
  edm::LogInfo("LutXml") << "Created map size: " << lut_map.size();

  struct timeval _t;
  gettimeofday(&_t, nullptr);
  double _time = (double)(_t.tv_sec) + (double)(_t.tv_usec) / 1000000.0;

  HcalEmap _emap("./backup/official_emap_v6.04_080905.txt");
  std::vector<HcalEmap::HcalEmapRow> &_map = _emap.get_map();
  edm::LogInfo("LutXml") << "HcalEmap contains " << _map.size() << " entries";

  int _counter = 0;
  for (std::vector<HcalEmap::HcalEmapRow>::const_iterator row = _map.begin(); row != _map.end(); ++row) {
    if (row->subdet == "HB") {
      HcalDetId det_id(HcalBarrel, row->ieta, row->iphi, row->idepth);
      uint32_t raw_id = det_id.rawId();
      std::vector<unsigned int> *l = getLutFast(raw_id);
      if (l)
        _counter++;
    }
    if (row->subdet == "HE") {
      HcalDetId det_id(HcalEndcap, row->ieta, row->iphi, row->idepth);
      uint32_t raw_id = det_id.rawId();
      std::vector<unsigned int> *l = getLutFast(raw_id);
      if (l)
        _counter++;
    }
    if (row->subdet == "HF") {
      HcalDetId det_id(HcalForward, row->ieta, row->iphi, row->idepth);
      uint32_t raw_id = det_id.rawId();
      std::vector<unsigned int> *l = getLutFast(raw_id);
      if (l)
        _counter++;
    }
    if (row->subdet == "HO") {
      HcalDetId det_id(HcalOuter, row->ieta, row->iphi, row->idepth);
      uint32_t raw_id = det_id.rawId();
      std::vector<unsigned int> *l = getLutFast(raw_id);
      if (l)
        _counter++;
    }
  }
  gettimeofday(&_t, nullptr);
  edm::LogInfo("LutXml") << "access to " << _counter
                         << " HCAL channels took: " << (double)(_t.tv_sec) + (double)(_t.tv_usec) / 1000000.0 - _time
                         << "sec";

  return 0;
}

HcalSubdetector LutXml::subdet_from_crate(int crate_, int slot, int fiber) {
  // HBHE: 0,1,4,5,10,11,14,15,17 (+20)
  // HF: 2,9,12  (+20)
  // HO: 3,6,7,13,18  (+20)
  int crate = crate_ < 20 ? crate_ : crate_ - 20;
  if (crate == 2 || crate == 9 || crate == 12)
    return HcalForward;
  else if (crate == 3 || crate == 6 || crate == 7 || crate == 13 || crate == 18)
    return HcalOuter;
  else if (crate == 0 || crate == 1 || crate == 4 || crate == 5 || crate == 10 || crate == 11 || crate == 14 ||
           crate == 15 || crate == 17) {
    if (slot % 3 == 1)
      return HcalBarrel;
    else if (slot % 3 == 0)
      return HcalEndcap;
    else if (fiber < 12)
      return HcalBarrel;
    else
      return HcalEndcap;
  }
  edm::LogWarning("LutXml::subdet_from_crate") << "crate " << crate_ << " is not accounted for";
  return HcalEmpty;
}

int LutXml::a_to_i(char *inbuf) {
  int result;
  sscanf(inbuf, "%d", &result);
  return result;
}

// organize all LUTs in XML into a map for fast access
//
// FIXME: uses hardcoded CRATE-to-subdetector mapping
// FIXME: it would be better to use some official map
//
int LutXml::create_lut_map(void) {
  //delete lut_map;
  lut_map.clear();
  //lut_map = new std::map<uint32_t,std::vector<unsigned int> >();

  if (document) {
    //DOMElement * rootElem =
    DOMNodeList *brick_list = document->getDocumentElement()->getElementsByTagName(brick);
    int n_of_bricks = brick_list->getLength();
    for (int i = 0; i != n_of_bricks; i++) {
      DOMElement *aBrick = (DOMElement *)(brick_list->item(i));
      DOMNodeList *par_list = aBrick->getElementsByTagName(XMLString::transcode("Parameter"));
      int n_of_par = par_list->getLength();
      int ieta = -99;
      int iphi = -99;
      int depth = -99;
      int crate = -99;
      int slot = -99;
      int fiber = -99;
      int lut_type = -99;
      int slb = -99;
      HcalSubdetector subdet;
      for (int j = 0; j != n_of_par; j++) {
        DOMElement *aPar = (DOMElement *)(par_list->item(j));
        char *aName = XMLString::transcode(aPar->getAttribute(XMLProcessor::_toXMLCh("name")));
        if (strcmp(aName, "IETA") == 0)
          ieta = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "IPHI") == 0)
          iphi = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "DEPTH") == 0)
          depth = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "CRATE") == 0)
          crate = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "SLOT") == 0)
          slot = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "FIBER") == 0)
          fiber = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "LUT_TYPE") == 0)
          lut_type = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
        if (strcmp(aName, "SLB") == 0)
          slb = a_to_i(XMLString::transcode(aPar->getFirstChild()->getNodeValue()));
      }
      subdet = subdet_from_crate(crate, slot, fiber);
      DOMElement *_data = (DOMElement *)(aBrick->getElementsByTagName(XMLString::transcode("Data"))->item(0));
      char *_str = XMLString::transcode(_data->getFirstChild()->getNodeValue());

      // get the LUT vector
      int _string_length = strlen(_str);
      std::vector<unsigned int> _lut;
      unsigned int _base = 16;
      unsigned int _item = 0;
      for (int i = 0; i != _string_length; i++) {
        bool _range = false;
        char ch_cur = _str[i];
        if (_base == 16)
          _range = (ch_cur >= '0' and ch_cur <= '9') || (ch_cur >= 'a' and ch_cur <= 'f') ||
                   (ch_cur >= 'A' and ch_cur <= 'F');
        else if (_base == 10)
          _range = (ch_cur >= '0' and ch_cur <= '9');
        if (_range) {
          if (ch_cur >= 'a' and ch_cur <= 'f')
            ch_cur += 10 - 'a';
          else if (ch_cur >= 'A' and ch_cur <= 'F')
            ch_cur += 10 - 'A';
          else if (ch_cur >= '0' and ch_cur <= '9')
            ch_cur += -'0';
          _item = _item * _base;
          _item += ch_cur;
          bool last_digit = false;
          if ((i + 1) == _string_length)
            last_digit = true;
          else {
            char ch_next = _str[i + 1];
            bool _range_next = false;
            if (_base == 16)
              _range_next = (ch_next >= '0' and ch_next <= '9') || (ch_next >= 'a' and ch_next <= 'f') ||
                            (ch_next >= 'A' and ch_next <= 'F');
            else if (_base == 10)
              _range_next = (ch_next >= '0' and ch_next <= '9');
            if (!_range_next)
              last_digit = true;
          }
          if (last_digit) {
            _lut.push_back(_item);
            _item = 0;
          }
        }
      }
      // filling the map
      uint32_t _key = 0;
      if (lut_type == 1) {
        HcalDetId _id(subdet, ieta, iphi, depth);
        _key = _id.rawId();
      } else if (lut_type == 2) {
        int version = (abs(ieta) > 29 && slb != 12 && crate > 20) ? 1 : 0;
        HcalTrigTowerDetId _id(ieta, iphi, 10 * version);
        _key = _id.rawId();
      } else
        continue;
      lut_map.insert(std::pair<uint32_t, std::vector<unsigned int> >(_key, _lut));
    }
  } else {
    edm::LogError("LutXml") << "XML file with LUTs is not loaded, cannot create map!";
  }

  return 0;
}

LutXml::const_iterator LutXml::begin() const { return lut_map.begin(); }

LutXml::const_iterator LutXml::end() const { return lut_map.end(); }

LutXml::const_iterator LutXml::find(uint32_t id) const { return lut_map.find(id); }