FRDFileHeader.h

Go to the documentation of this file.

#ifndef IOPool_Streamer_FRDFileHeader_h
#define IOPool_Streamer_FRDFileHeader_h

#include <array>
#include <cstddef>
#include <cstdint>

/*
 * FRD File Header optionally found at the beginning of the FRD RAW file
 *
 * Version 1 Format:
 *   uint8_t [4] - id contanining 4 characters: 0x52, 0x41, 0x57, 0x5f  "RAW_"
 *   uint8_t [4] - version string 4 characters: 0x30, 0x30, 0x30, 0x31  "0001"
 *   uint16_t - header size: 24
 *   uint16_t - number of events in the RAW file
 *   uint32_t - lumisection
 *   uint64_t - total size of the raw file (including header)
 *
 * */

namespace edm::streamer {
  constexpr std::array<unsigned char, 4> FRDFileHeader_id{{0x52, 0x41, 0x57, 0x5f}};
  constexpr std::array<unsigned char, 4> FRDFileVersion_1{{0x30, 0x30, 0x30, 0x31}};
  constexpr std::array<unsigned char, 4> FRDFileVersion_2{{0x30, 0x30, 0x30, 0x32}};

  struct FRDFileHeaderIdentifier {
    FRDFileHeaderIdentifier(const std::array<uint8_t, 4>& id, const std::array<uint8_t, 4>& version)
        : id_(id), version_(version) {}

    std::array<uint8_t, 4> id_;
    std::array<uint8_t, 4> version_;
  };

  struct FRDFileHeaderContent_v1 {
    FRDFileHeaderContent_v1(uint16_t eventCount, uint32_t lumiSection, uint64_t fileSize)
        : headerSize_(sizeof(FRDFileHeaderContent_v1) + sizeof(FRDFileHeaderIdentifier)),
          eventCount_(eventCount),
          lumiSection_(lumiSection),
          fileSize_(fileSize) {}

    uint16_t headerSize_;
    uint16_t eventCount_;
    uint32_t lumiSection_;
    uint64_t fileSize_;
  };

  struct FRDFileHeader_v1 {
    FRDFileHeader_v1(uint16_t eventCount, uint32_t lumiSection, uint64_t fileSize)
        : id_(FRDFileHeader_id, FRDFileVersion_1), c_(eventCount, lumiSection, fileSize) {}

    FRDFileHeaderIdentifier id_;
    FRDFileHeaderContent_v1 c_;
  };

  struct FRDFileHeaderContent_v2 {
    FRDFileHeaderContent_v2(
        uint16_t dataType, uint16_t eventCount, uint32_t runNumber, uint32_t lumiSection, uint64_t fileSize)
        : headerSize_(sizeof(FRDFileHeaderContent_v2) + sizeof(FRDFileHeaderIdentifier)),
          dataType_(dataType),
          eventCount_(eventCount),
          runNumber_(runNumber),
          lumiSection_(lumiSection),
          fileSize_(fileSize) {}

    uint16_t headerSize_;
    uint16_t dataType_;
    uint32_t eventCount_;
    uint32_t runNumber_;
    uint32_t lumiSection_;
    uint64_t fileSize_;
  };

  struct FRDFileHeader_v2 {
    FRDFileHeader_v2(uint16_t dataType, uint16_t eventCount, uint32_t runNumber, uint32_t lumiSection, uint64_t fileSize)
        : id_(FRDFileHeader_id, FRDFileVersion_2), c_(dataType, eventCount, runNumber, lumiSection, fileSize) {}

    FRDFileHeaderIdentifier id_;
    FRDFileHeaderContent_v2 c_;
  };

  inline uint16_t getFRDFileHeaderVersion(const std::array<uint8_t, 4>& id, const std::array<uint8_t, 4>& version) {
    size_t i;
    for (i = 0; i < 4; i++)
      if (id[i] != FRDFileHeader_id[i])
        return 0;  //not FRD file header
    uint16_t ret = 0;
    for (i = 0; i < 4; i++) {
      if (version[i] > '9' || version[i] < '0')
        return 0;  //NaN sequence
      ret = ret * 10 + (uint16_t)(version[i] - '0');
    }
    return ret;
  }
}  // namespace edm::streamer
#endif