IOVComp

IOVProxyData

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
#include <memory>

#include "CondCore/CondDB/interface/IOVProxy.h"
#include "CondCore/CondDB/interface/Time.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "SessionImpl.h"

using cond::time::lumiIdToLumiNr;
using cond::time::lumiIdToRun;
namespace cond {

  namespace persistency {

    // comparison functor for iov tuples: Time_t only and Time_t,string
    struct IOVComp {
      bool operator()(const cond::Time_t& x, const cond::Time_t& y) { return (x < y); }

      bool operator()(const cond::Time_t& x, const std::tuple<cond::Time_t, cond::Hash>& y) {
        return (x < std::get<0>(y));
      }
    };

    // function to search in the vector the target time
    template <typename T>
    typename std::vector<T>::const_iterator search(const cond::Time_t& val, const std::vector<T>& container) {
      if (container.empty())
        return container.end();
      auto p = std::upper_bound(container.begin(), container.end(), val, IOVComp());
      return (p != container.begin()) ? p - 1 : container.end();
    }

    IOVArray::Iterator::Iterator() : m_current(), m_parent(nullptr) {}

    IOVArray::Iterator::Iterator(IOVContainer::const_iterator current, const IOVArray* parent)
        : m_current(current), m_parent(parent) {}

    IOVArray::Iterator::Iterator(const Iterator& rhs) : m_current(rhs.m_current), m_parent(rhs.m_parent) {}

    IOVArray::Iterator& IOVArray::Iterator::operator=(const Iterator& rhs) {
      if (this != &rhs) {
        m_current = rhs.m_current;
        m_parent = rhs.m_parent;
      }
      return *this;
    }

    cond::Iov_t IOVArray::Iterator::operator*() {
      cond::Iov_t retVal;
      retVal.since = std::get<0>(*m_current);
      auto next = m_current;
      next++;
      if (next == m_parent->m_array->end()) {
        retVal.till = cond::time::MAX_VAL;
      } else {
        retVal.till = cond::time::tillTimeFromNextSince(std::get<0>(*next), m_parent->m_tagInfo.timeType);
      }
      // default is the end of validity when set...
      if (retVal.till > m_parent->m_tagInfo.endOfValidity) {
        retVal.till = m_parent->m_tagInfo.endOfValidity;
      }
      retVal.payloadId = std::get<1>(*m_current);

      return retVal;
    }

    IOVArray::Iterator& IOVArray::Iterator::operator++() {
      m_current++;
      return *this;
    }

    IOVArray::Iterator IOVArray::Iterator::operator++(int) {
      Iterator tmp(*this);
      operator++();
      return tmp;
    }

    bool IOVArray::Iterator::operator==(const Iterator& rhs) const {
      if (m_current != rhs.m_current)
        return false;
      if (m_parent != rhs.m_parent)
        return false;
      return true;
    }

    bool IOVArray::Iterator::operator!=(const Iterator& rhs) const { return !operator==(rhs); }

    IOVArray::IOVArray() : m_array(new IOVContainer) {}

    IOVArray::IOVArray(const IOVArray& rhs) : m_array(), m_tagInfo(rhs.m_tagInfo) {
      m_array = std::make_unique<IOVContainer>(*rhs.m_array);
    }

    IOVArray& IOVArray::operator=(const IOVArray& rhs) {
      m_array = std::make_unique<IOVContainer>(*rhs.m_array);
      m_tagInfo = rhs.m_tagInfo;
      return *this;
    }

    const cond::Tag_t& IOVArray::tagInfo() const { return m_tagInfo; }

    IOVArray::Iterator IOVArray::begin() const { return Iterator(m_array->begin(), this); }

    IOVArray::Iterator IOVArray::end() const { return Iterator(m_array->end(), this); }

    IOVArray::Iterator IOVArray::find(cond::Time_t time) const { return Iterator(search(time, *m_array), this); }

    size_t IOVArray::size() const { return m_array->size(); }

    // returns true if at least one IOV is in the sequence.
    bool IOVArray::isEmpty() const { return m_array->empty(); }

    // implementation details...
    // only hosting data in this case
    class IOVProxyData {
    public:
      IOVProxyData() : iovSequence() {}

      // tag data
      cond::Tag_t tagInfo;
      // iov data
      boost::posix_time::ptime snapshotTime;
      cond::Time_t groupLowerIov = cond::time::MAX_VAL;
      cond::Time_t groupHigherIov = cond::time::MIN_VAL;
      bool cacheInitialized = false;
      std::vector<cond::Time_t> sinceGroups;
      IOVContainer iovSequence;
      // monitoring data
      size_t numberOfQueries = 0;
    };

    IOVProxy::IOVProxy(const std::shared_ptr<SessionImpl>& session) : m_data(new IOVProxyData), m_session(session) {}

    void IOVProxy::load(const std::string& tagName) {
      boost::posix_time::ptime notime;
      load(tagName, notime);
    }

    void IOVProxy::load(const std::string& tagName, const boost::posix_time::ptime& snapshotTime) {
      if (!m_data.get())
        return;

      // clear
      reset();

      checkTransaction("IOVProxyNew::load");

      int dummy;
      if (!m_session->iovSchema().tagTable().select(tagName,
                                                    m_data->tagInfo.timeType,
                                                    m_data->tagInfo.payloadType,
                                                    m_data->tagInfo.synchronizationType,
                                                    m_data->tagInfo.endOfValidity,
                                                    m_data->tagInfo.lastValidatedTime,
                                                    dummy)) {
        throwException("Tag \"" + tagName + "\" has not been found in the database.", "IOVProxy::load");
      }
      m_data->tagInfo.name = tagName;
      m_data->snapshotTime = snapshotTime;
    }

    void IOVProxy::loadGroups() {
      //if( !m_data.get() ) return;

      // clear
      resetIOVCache();

      //checkTransaction( "IOVProxyNew::load" );
      m_session->iovSchema().iovTable().getGroups(m_data->tagInfo.name,
                                                  m_data->snapshotTime,
                                                  cond::time::sinceGroupSize(m_data->tagInfo.timeType),
                                                  m_data->sinceGroups);
      m_data->cacheInitialized = true;
    }

    IOVArray IOVProxy::selectAll() {
      boost::posix_time::ptime no_time;
      return selectAll(no_time);
    }

    IOVArray IOVProxy::selectAll(const boost::posix_time::ptime& snapshottime) {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::selectAll");
      checkTransaction("IOVProxy::selectAll");
      IOVArray ret;
      ret.m_tagInfo = m_data->tagInfo;
      m_session->iovSchema().iovTable().select(
          m_data->tagInfo.name, cond::time::MIN_VAL, cond::time::MAX_VAL, snapshottime, *ret.m_array);
      return ret;
    }

    IOVArray IOVProxy::selectRange(const cond::Time_t& begin, const cond::Time_t& end) {
      boost::posix_time::ptime no_time;
      return selectRange(begin, end, no_time);
    }

    IOVArray IOVProxy::selectRange(const cond::Time_t& begin,
                                   const cond::Time_t& end,
                                   const boost::posix_time::ptime& snapshotTime) {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::selectRange");

      checkTransaction("IOVProxy::selectRange");

      IOVArray ret;
      ret.m_tagInfo = m_data->tagInfo;
      m_session->iovSchema().iovTable().getRange(m_data->tagInfo.name, begin, end, snapshotTime, *ret.m_array);
      return ret;
    }

    bool IOVProxy::selectRange(const cond::Time_t& begin, const cond::Time_t& end, IOVContainer& destination) {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::selectRange");

      checkTransaction("IOVProxy::selectRange");

      boost::posix_time::ptime no_time;
      size_t prevSize = destination.size();
      m_session->iovSchema().iovTable().getRange(m_data->tagInfo.name, begin, end, no_time, destination);
      size_t niov = destination.size() - prevSize;
      return niov > 0;
    }

    void IOVProxy::resetIOVCache() {
      if (m_data.get()) {
        m_data->groupLowerIov = cond::time::MAX_VAL;
        m_data->groupHigherIov = cond::time::MIN_VAL;
        m_data->sinceGroups.clear();
        m_data->iovSequence.clear();
        m_data->numberOfQueries = 0;
      }
    }

    void IOVProxy::reset() {
      if (m_data.get()) {
        m_data->tagInfo.clear();
      }
      resetIOVCache();
    }

    cond::Tag_t IOVProxy::tagInfo() const { return m_data.get() ? m_data->tagInfo : cond::Tag_t(); }

    void setTillToLastIov(cond::Iov_t& target, cond::Time_t endOfValidity) {
      if (endOfValidity < cond::time::MAX_VAL) {
        if (target.since >= endOfValidity) {
          target.clear();
        } else {
          target.till = endOfValidity;
        }
      } else {
        target.till = cond::time::MAX_VAL;
      }
    }

    cond::TagInfo_t IOVProxy::iovSequenceInfo() const {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::iovSequenceInfo");
      checkTransaction("IOVProxy::iovSequenceInfo");
      cond::TagInfo_t ret;
      m_session->iovSchema().iovTable().getSize(m_data->tagInfo.name, m_data->snapshotTime, ret.size);
      cond::Iov_t last;
      bool ok = m_session->iovSchema().iovTable().getLastIov(
          m_data->tagInfo.name, m_data->snapshotTime, ret.lastInterval.since, ret.lastInterval.payloadId);
      if (ok) {
        setTillToLastIov(ret.lastInterval, m_data->tagInfo.endOfValidity);
      }
      return ret;
    }

    std::tuple<std::string, boost::posix_time::ptime, boost::posix_time::ptime> IOVProxy::getMetadata() const {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::getMetadata");
      checkTransaction("IOVProxy::getMetadata");
      std::tuple<std::string, boost::posix_time::ptime, boost::posix_time::ptime> ret;
      if (!m_session->iovSchema().tagTable().getMetadata(
              m_data->tagInfo.name, std::get<0>(ret), std::get<1>(ret), std::get<2>(ret))) {
        throwException("Metadata for tag \"" + m_data->tagInfo.name + "\" have not been found in the database.",
                       "IOVProxy::getMetadata");
      }
      return ret;
    }

    void IOVProxy::checkTransaction(const std::string& ctx) const {
      if (!m_session.get())
        throwException("The session is not active.", ctx);
      if (!m_session->isTransactionActive(false))
        throwException("The transaction is not active.", ctx);
    }

    void printTagInfoAndRanges(edm::LogSystem& log,
                               const IOVProxyData& iovProxyData,
                               cond::Time_t lowerGroup,
                               cond::Time_t higherGroup) {
      log << "Fetched new IOV for '" << iovProxyData.tagInfo.name << "'\n"
          << "payload type: " << iovProxyData.tagInfo.payloadType << "\n"
          << "request interval [ " << lowerGroup << " , " << higherGroup << " ]\n"
          << "new range [ " << iovProxyData.groupLowerIov << " , " << iovProxyData.groupHigherIov << " ]\n";
      if (iovProxyData.tagInfo.timeType == cond::TimeType::lumiid) {
        log << "request interval (run, LS): [ ("  // comments to override code-format
            << lumiIdToRun(lowerGroup) << ", " << lumiIdToLumiNr(lowerGroup) << ") , ("  //
            << lumiIdToRun(higherGroup) << ", " << lumiIdToLumiNr(higherGroup) << ") ]\n"
            << "new range (run, LS): [ ("  //
            << lumiIdToRun(iovProxyData.groupLowerIov) << ", " << lumiIdToLumiNr(iovProxyData.groupLowerIov) << ") , ("
            << lumiIdToRun(iovProxyData.groupHigherIov) << ", " << lumiIdToLumiNr(iovProxyData.groupHigherIov)
            << ") ]\n";
      }
    }

    void printIovsAndHashesOfSequence(edm::LogSystem& log, const IOVProxyData& iovProxyData) {
      const bool isLumiid = iovProxyData.tagInfo.timeType == cond::TimeType::lumiid;
      log << "#entries " << iovProxyData.iovSequence.size() << "\n"
          << "sequence [iov " << (isLumiid ? "(run, LS)" : "") << ", hash]:\n";
      for (const auto& [iov, hash] : iovProxyData.iovSequence) {
        log << iov << " ";
        if (isLumiid) {
          log << "(" << lumiIdToRun(iov) << ", " << lumiIdToLumiNr(iov) << ")";
        }
        log << ", " << hash << ",\n";
      }
    }

    void printIOVSequenceDiagnostics(const IOVProxyData& iovProxyData,
                                     cond::Time_t lowerGroup,
                                     cond::Time_t higherGroup) {
      edm::LogSystem log("NewIOV");  // creating here so everything is in one message
      printTagInfoAndRanges(log, iovProxyData, lowerGroup, higherGroup);
      printIovsAndHashesOfSequence(log, iovProxyData);
    }

    void IOVProxy::fetchSequence(cond::Time_t lowerGroup, cond::Time_t higherGroup) {
      m_data->iovSequence.clear();
      m_session->iovSchema().iovTable().select(
          m_data->tagInfo.name, lowerGroup, higherGroup, m_data->snapshotTime, m_data->iovSequence);

      if (m_data->iovSequence.empty()) {
        m_data->groupLowerIov = cond::time::MAX_VAL;
        m_data->groupHigherIov = cond::time::MIN_VAL;
      } else {
        if (lowerGroup > cond::time::MIN_VAL) {
          m_data->groupLowerIov = std::get<0>(m_data->iovSequence.front());
        } else {
          m_data->groupLowerIov = cond::time::MIN_VAL;
        }
        m_data->groupHigherIov = std::get<0>(m_data->iovSequence.back());
        if (higherGroup < cond::time::MAX_VAL) {
          m_data->groupHigherIov = cond::time::tillTimeFromNextSince(higherGroup, m_data->tagInfo.timeType);
        } else {
          m_data->groupHigherIov = cond::time::MAX_VAL;
        }
      }
      m_data->numberOfQueries++;

      if (m_printDebug) {
        printIOVSequenceDiagnostics(*m_data, lowerGroup, higherGroup);
      }
    }

    cond::Iov_t IOVProxy::getInterval(cond::Time_t time) {
      if (!m_data.get())
        throwException("No tag has been loaded.", "IOVProxy::getInterval");
      checkTransaction("IOVProxy::getInterval");
      if (!m_data->cacheInitialized)
        loadGroups();
      cond::Iov_t retVal;
      // organize iovs in pages...
      // first check the available iov cache:
      if (m_data->groupLowerIov == cond::time::MAX_VAL ||  // case 0 : empty cache ( the first request )
          time < m_data->groupLowerIov || time >= m_data->groupHigherIov) {  // case 1 : target outside

        // a new query required!
        // first determine the groups
        auto iGLow = search(time, m_data->sinceGroups);
        if (iGLow == m_data->sinceGroups.end()) {
          // no suitable group=no iov at all! exiting...
          return retVal;
        }
        auto iGHigh = iGLow;
        cond::Time_t lowG = *iGLow;
        iGHigh++;
        cond::Time_t highG = cond::time::MAX_VAL;
        if (iGHigh != m_data->sinceGroups.end())
          highG = *iGHigh;

        // finally, get the iovs for the selected group interval!!
        fetchSequence(lowG, highG);
      }

      // the current iov set is a good one...
      auto iIov = search(time, m_data->iovSequence);
      if (iIov == m_data->iovSequence.end()) {
        return retVal;
      }

      retVal.since = std::get<0>(*iIov);
      auto next = iIov;
      next++;

      // default is the end of validity when set...
      retVal.till = m_data->tagInfo.endOfValidity;
      // for the till, the next element of the sequence has to be looked up
      cond::Time_t tillVal;
      if (next != m_data->iovSequence.end()) {
        tillVal = cond::time::tillTimeFromNextSince(std::get<0>(*next), m_data->tagInfo.timeType);
      } else {
        tillVal = m_data->groupHigherIov;
      }
      if (tillVal < retVal.till)
        retVal.till = tillVal;
      //
      retVal.payloadId = std::get<1>(*iIov);
      return retVal;
    }

    cond::Iov_t IOVProxy::getLast() {
      checkTransaction("IOVProxy::getLast");
      cond::Iov_t ret;
      bool ok = m_session->iovSchema().iovTable().getLastIov(
          m_data->tagInfo.name, m_data->snapshotTime, ret.since, ret.payloadId);
      if (ok) {
        setTillToLastIov(ret, m_data->tagInfo.endOfValidity);
      }
      return ret;
    }

    int IOVProxy::loadedSize() const { return m_data.get() ? m_data->iovSequence.size() : 0; }

    int IOVProxy::sequenceSize() const {
      checkTransaction("IOVProxy::sequenceSize");
      size_t ret = 0;
      m_session->iovSchema().iovTable().getSize(m_data->tagInfo.name, m_data->snapshotTime, ret);

      return ret;
    }

    size_t IOVProxy::numberOfQueries() const { return m_data.get() ? m_data->numberOfQueries : 0; }

    std::pair<cond::Time_t, cond::Time_t> IOVProxy::loadedGroup() const {
      return m_data.get() ? std::make_pair(m_data->groupLowerIov, m_data->groupHigherIov)
                          : std::make_pair(cond::time::MAX_VAL, cond::time::MIN_VAL);
    }

    const std::shared_ptr<SessionImpl>& IOVProxy::session() const { return m_session; }

  }  // namespace persistency

}  // namespace cond