Mapper.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef __O2_EMCAL_MAPPER_H__
#define __O2_EMCAL_MAPPER_H__
 
#include <array>
#include <cstdint>
#include <exception>
#include <functional>
#include <iosfwd>
#include <unordered_map>
#include <sstream>
#include <string>
#include <boost/container_hash/hash.hpp>
 
#include "fmt/format.h"
#include "RStringView.h"
#include "Rtypes.h"
#include "DataFormatsEMCAL/Constants.h"
 
namespace o2
{
 
namespace emcal
{
 
class Mapper
{
 public:
  struct ChannelID {
    uint8_t mRow;               
    uint8_t mColumn;            
    ChannelType_t mChannelType; 
 
    bool operator==(const ChannelID& other) const
    {
      return mRow == other.mRow && mColumn == other.mColumn && mChannelType == other.mChannelType;
    }
    friend std::ostream& operator<<(std::ostream& stream, const Mapper::ChannelID& channel);
  };
 
  struct ChannelIDHasher {
 
    size_t operator()(const ChannelID& s) const
    {
      std::size_t seed = 0;
      boost::hash_combine(seed, s.mRow);
      boost::hash_combine(seed, s.mColumn);
      boost::hash_combine(seed, o2::emcal::channelTypeToInt(s.mChannelType));
      return seed;
      /*
      size_t h1 = std::hash<int>()(s.mRow);
      size_t h2 = std::hash<int>()(s.mColumn);
      size_t h3 = std::hash<int>()(o2::emcal::channelTypeToInt(s.mChannelType));
      return ((h1 ^ (h2 << 1)) >> 1) ^ (h3 << 1);
      */
    }
  };
 
  class AddressNotFoundException : public std::exception
  {
   public:
    AddressNotFoundException(int address) : exception(),
                                            mAddress(address),
                                            mMessage()
    {
      std::stringstream msgbuilder;
      msgbuilder << "Hardware address " << address << "(0x" << std::hex << address << std::dec << ") not found";
      mMessage = msgbuilder.str();
    }
 
    ~AddressNotFoundException() noexcept override = default;
 
    const char* what() const noexcept override { return mMessage.data(); }
 
    int getAddress() const noexcept { return mAddress; }
 
   private:
    int mAddress;         
    std::string mMessage; 
  };
 
  class AddressRangeException : public std::exception
  {
   public:
    AddressRangeException(int address, int maxaddress) : exception(),
                                                         mAddress(address),
                                                         mMaxAddress(maxaddress),
                                                         mMessage("Hardware (ALTRO) address (" + std::to_string(mAddress) + " outside the range (0 -> " + std::to_string(mMaxAddress) + ") !")
    {
    }
 
    ~AddressRangeException() noexcept override = default;
 
    const char* what() const noexcept override { return mMessage.data(); }
 
    int getAddress() const noexcept { return mAddress; }
 
    int getMaxAddress() const noexcept { return mMaxAddress; }
 
   private:
    int mAddress;         
    int mMaxAddress;      
    std::string mMessage; 
  };
 
  class ChannelNotFoundException : public std::exception
  {
   public:
    ChannelNotFoundException(ChannelID id) : std::exception(),
                                             mChannelID(id),
                                             mMessage()
    {
      std::stringstream msgbuilder;
      msgbuilder << "Channel with " << mChannelID << " not found.";
      mMessage = msgbuilder.str();
    }
 
    ~ChannelNotFoundException() noexcept override = default;
 
    const char* what() const noexcept override
    {
      return mMessage.data();
    }
 
    const ChannelID& getChannel() const { return mChannelID; }
 
   private:
    ChannelID mChannelID; 
    std::string mMessage; 
  };
 
  class FileFormatException : public std::exception
  {
   public:
    FileFormatException(const std::string_view errormessage) : std::exception(),
                                                               mMessage(std::string("Failure reading input file: ") + errormessage.data())
    {
    }
 
    ~FileFormatException() noexcept override = default;
 
    const char* what() const noexcept override
    {
      return mMessage.data();
    }
 
   private:
    std::string mMessage; 
  };
 
  class InitStatusException : public std::exception
  {
   public:
    InitStatusException() = default;
 
    ~InitStatusException() noexcept override = default;
 
    const char* what() const noexcept override { return "Mapping not properly initialized"; }
  };
 
  Mapper() = default;
 
  Mapper(const std::string_view inputfile);
 
  ~Mapper() = default;
 
  ChannelID getChannelID(unsigned int hardawareaddress) const;
 
  uint8_t getRow(unsigned int hardawareaddress) const
  {
    return getChannelID(hardawareaddress).mRow;
  }
 
  uint8_t getColumn(unsigned int hardawareaddress) const
  {
    return getChannelID(hardawareaddress).mColumn;
  }
 
  ChannelType_t getChannelType(unsigned int hardawareaddress) const
  {
    return getChannelID(hardawareaddress).mChannelType;
  }
 
  unsigned int getHardwareAddress(uint8_t row, uint8_t col, ChannelType_t channeltype) const;
 
  void setMapping(const std::string_view inputfile);
 
 private:
  void init(const std::string_view inputfile);
 
  std::unordered_map<unsigned int, ChannelID> mMapping;                         
  std::unordered_map<ChannelID, unsigned int, ChannelIDHasher> mInverseMapping; 
  bool mInitStatus = false;                                                     
 
  ClassDefNV(Mapper, 1);
};
 
class MappingHandler
{
 public:
  class DDLInvalid final : public std::exception
  {
   public:
    DDLInvalid(int ddlID) : mDDL(ddlID) { mMessage = fmt::format("DDL {0} not existing for EMCAL", mDDL); };
 
    ~DDLInvalid() noexcept final = default;
 
    const char* what() const noexcept final { return mMessage.data(); }
 
    int getDDDL() const { return mDDL; }
 
   private:
    std::string mMessage; 
    int mDDL;             
  };
 
  MappingHandler();
 
  ~MappingHandler() = default;
 
  Mapper& getMappingForDDL(unsigned int ddl);
 
  int getFEEForChannelInDDL(unsigned int dll, unsigned int channelFEC, unsigned int branch);
 
 private:
  std::array<Mapper, 4> mMappings; 
 
  ClassDefNV(MappingHandler, 1);
};
 
std::ostream& operator<<(std::ostream& stream, const Mapper::ChannelID& channel);
 
} // namespace emcal
 
} // namespace o2
 
#endif //__O2_EMCAL_MAPPER_H__