ProtocolMmap.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
 
    This file is part of uHAL.
 
    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.
 
    uHAL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    uHAL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.
 
 
      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk
 
      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch
 
      Tom Williams, Rutherford Appleton Laboratory, Oxfordshire
      email: tom.williams <AT> cern.ch
 
---------------------------------------------------------------------------
*/
 
#ifndef _uhal_ProtocolMmap_hpp_
#define _uhal_ProtocolMmap_hpp_
 
 
#include <chrono>
#include <deque>                           // for deque
#include <istream>                         // for istream
#include <memory>
#include <stddef.h>                        // for size_t
#include <stdint.h>                        // for uint32_t, uint8_t
#include <string>                          // for string
#include <utility>                         // for pair
#include <vector>                          // for vector
 
#include "uhal/ClientInterface.hpp"
#include "uhal/detail/RobustSessionMutex.hpp"
#include "uhal/detail/SharedObject.hpp"
#include "uhal/log/exception.hpp"
#include "uhal/ProtocolIPbus.hpp"
 
 
 
namespace uhal
{
  class Buffers;
  struct URI;
 
  namespace exception
  {
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( MmapTimeout , ClientTimeout , "Exception class to handle the case in which the PCIe connection timed out." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( MmapInitialisationError , TransportLayerError , "Exception class to handle a failure to read from the specified device files during initialisation." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( MmapCommunicationError , TransportLayerError , "Exception class to handle a low-level seek/read/write error after initialisation." )
  }
 
  class Mmap : public IPbus< 2 , 0 >
  {
    private:
      class File {
      public:
        File(const std::string& aPath, int aFlags);
        ~File();
 
        const std::string& getPath() const;
        void setPath(const std::string& aPath);
 
        void setOffset(size_t aOffset);
 
        void open();
        void close();
 
        void read(const uint32_t aAddr, const uint32_t aNrWords, std::vector<uint32_t>& aValues);
 
        void write(const uint32_t aAddr, const std::vector<std::pair<const uint8_t*, size_t> >& aData);
 
        bool haveLock() const;
 
        void lock();
 
        void unlock();
 
      private:
        std::string mPath;
        int mFd;
        int mFlags;
        bool mLocked;
        off_t mOffset;
        void* mMmapPtr;
        void* mMmapIOPtr;
      };
 
      template <typename T>
      struct HexTo {
        T value;
        operator T() const {return value;}
        friend std::istream& operator>>(std::istream& in, HexTo& out)
        {
          in >> std::hex >> out.value;
          return in;
        }
      };
 
      Mmap ( const Mmap& aMmap );
 
      Mmap& operator= ( const Mmap& aMmap );
 
      static std::string getSharedMemName(const std::string& );
 
    public:
      Mmap ( const std::string& aId, const URI& aUri );
 
      virtual ~Mmap();
 
    private:
 
      void implementDispatch ( std::shared_ptr< Buffers > aBuffers );
 
      virtual void Flush();
 
      virtual void dispatchExceptionHandler();
 
      typedef IPbus< 2 , 0 > InnerProtocol;
 
      typedef std::chrono::steady_clock SteadyClock_t;
 
      uint32_t getMaxSendSize();
 
      uint32_t getMaxReplySize();
 
      void connect();
 
      void connect(detail::ScopedSessionLock& );
 
      void disconnect();
 
      void write(const std::shared_ptr<Buffers>& aBuffers);
 
      void read();
 
      bool mConnected;
 
      File mDeviceFile;
 
      detail::SharedObject<detail::RobustSessionMutex> mIPCMutex;
      bool mIPCExternalSessionActive;
      uint64_t mIPCSessionCount;
 
      std::chrono::microseconds mSleepDuration;
 
      uint32_t mNumberOfPages, mMaxInFlight, mPageSize, mMaxPacketSize, mIndexNextPage, mPublishedReplyPageCount, mReadReplyPageCount;
 
      std::deque < std::shared_ptr< Buffers > > mReplyQueue;
  };
 
 
}
 
 
#endif