PerfTester.hxx

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/>.

      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch

      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk

---------------------------------------------------------------------------
*/

#ifndef _uhal_tests_PerfTester_hpp_
#define _uhal_tests_PerfTester_hpp_

// C++ headers
#include <vector>
#include <string>

// Linux C++ headers
#include <sys/time.h>

// uHAL headers
#include "uhal/uhal.hpp"

namespace uhal
{
  namespace tests
  {
    class PerfTester
    {
      public:

        PerfTester();

        ~PerfTester() {}


        int run ( int argc, char* argv[] );


      private:

        // PRIVATE TYPEDEFS

        typedef uint32_t U32;

        typedef std::vector< U32 > U32Vec;

        typedef uhal::ValVector< U32 > U32ValVec;

        typedef std::vector< std::string > StringVec;

        typedef void ( PerfTester::*PtrToTestFunc ) ();

        typedef std::map<std::string, PtrToTestFunc> TestFuncMap;

        typedef std::map<std::string, std::string> TestDescMap;

        typedef boost::shared_ptr<uhal::ClientInterface> ClientPtr;

        typedef std::vector< ClientPtr > ClientVec;


        // PRIVATE MEMBER VARIABLES

        TestDescMap m_testDescMap;  
        TestFuncMap m_testFuncMap;  
        StringVec m_deviceURIs;  
        ClientVec m_clients;  
        std::string m_testName;  
        uint64_t m_iterations;  
        std::string m_baseAddrStr;  
        boost::uint32_t m_baseAddr;  
        boost::uint32_t m_bandwidthTestDepth;  
        bool m_verbose;  
        bool m_perIterationDispatch; 
        bool m_includeConnect; 


        // PRIVATE MEMBER FUNCTIONS - Test infrastructure

        void outputHelpText ( const std::string& argDescriptions ) const;

        void outputTestDescriptionsList() const;

        bool badInput() const;

        void outputUserChoices() const;

        void buildClients();

        void outputStandardResults ( double totalSeconds ) const;

        static uint32_t getRandomBlockSize ( const uint32_t maxSize );

        static U32Vec getRandomBuffer ( unsigned size );

        bool buffersEqual ( const U32Vec& writeBuffer, const U32ValVec& readBuffer ) const;

        static bool validation_test_single_write_read ( uhal::ClientInterface& c, const uint32_t addr, const bool perTransactionDispatch, const bool aVerbose );

        static bool validation_test_block_write_read ( uhal::ClientInterface& c, const uint32_t addr, const uint32_t depth, const bool perTransactionDispatch, const bool aVerbose );

        static bool validation_test_write_rmwbits_read ( uhal::ClientInterface& c, const uint32_t addr, const bool perTransactionDispatch, const bool aVerbose );

        static bool validation_test_write_rmwsum_read ( uhal::ClientInterface& c, const uint32_t addr, const bool perTransactionDispatch, const bool aVerbose );

        // PRIVATE MEMBER FUNCTIONS - IPbus test functions that users can run

        void bandwidthRxTest();  
        void bandwidthTxTest();  
        void validationTest();   

    public:

        static bool runValidationTest(const std::vector<ClientInterface*>& aClients, const uint32_t aBaseAddr, const uint32_t aDepth, const size_t aNrIterations, const bool aDispatchEachIteration, const bool aVerbose);

    private:
        void sandbox();          

        // PRIVATE CLASSES

        class QueuedTransaction
        {
          public:
            QueuedTransaction() {  }
            virtual ~QueuedTransaction() {  }

            virtual bool check_values() = 0;
        };


        class QueuedBlockRead : public QueuedTransaction
        {
          public:
            QueuedBlockRead ( const uint32_t addr, const ValVector<uint32_t>& valVector, std::vector<uint32_t>::const_iterator expectedValuesIt );
            ~QueuedBlockRead();

            virtual bool check_values();

          private:
            // PRIVATE MEMBER DATA
            uint32_t m_depth, m_addr;
            ValVector<uint32_t> m_valVector;
            std::vector<uint32_t> m_expected;
        };


        class QueuedBlockWrite : public QueuedTransaction
        {
          public:
            QueuedBlockWrite ( const uint32_t addr, const uint32_t depth, const ValHeader& valHeader );
            ~QueuedBlockWrite();

            virtual bool check_values();

          private:
            // PRIVATE MEMBER DATA
            uint32_t m_depth, m_addr;
            ValHeader m_valHeader;
        };


        class QueuedRmwBits : public QueuedTransaction
        {
          public:
            QueuedRmwBits ( const uint32_t addr, const uint32_t a, const uint32_t b, const ValWord<uint32_t>& valWord, const uint32_t expected );
            ~QueuedRmwBits();
            virtual bool check_values();

          private:
            const uint32_t m_addr, m_and, m_or;
            ValWord<uint32_t> m_valWord;
            const uint32_t m_expected;
        };


        class QueuedRmwSum : public QueuedTransaction
        {
          public:
            QueuedRmwSum ( const uint32_t addr, const uint32_t a, const ValWord<uint32_t>& valWord, const uint32_t expected );
            ~QueuedRmwSum();
            virtual bool check_values();

          private:
            const uint32_t m_addr, m_addend;
            ValWord<uint32_t> m_valWord;
            const uint32_t m_expected;
        };

    }; /* End of class PerfTester */

  }  /* End of namespace tests */

} /* End of namespace uhal */

#endif /* _uhal_tests_PerfTester_hpp_ */