GenericEventHandler.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste 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 Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef GENERICEVENTHANDLER_HPP_
#define GENERICEVENTHANDLER_HPP_

#include <cassert>
#include <ctime>
#include <iostream>

#include "Exception.hpp"
#include "PetscTools.hpp"

template <unsigned NUM_EVENTS, class CONCRETE>
class GenericEventHandler
{
    friend class TestGenericEventHandler;
    friend class TestCellBasedEventHandler;
    friend class TestHeartEventHandler;

private:

    std::vector<double> mWallTime; 
    std::vector<bool> mHasBegun; 
    bool mEnabled; 
    bool mInUse; 
    static inline void MilliSleep(unsigned milliseconds)
    {
        double start = MPI_Wtime();
        double min_Wtime = milliseconds/1000.0 + start;
        while (MPI_Wtime() < min_Wtime)
        {
            //pause;
        }
    }

    inline double GetWallTime()
    {
        return MPI_Wtime();
    }

    inline double ConvertWallTimeToMilliseconds(double wallTime)
    {
        return wallTime*1000.0;
    }

    inline double ConvertWallTimeToSeconds(double wallTime)
    {
        return wallTime;
    }

public:

    static GenericEventHandler<NUM_EVENTS, CONCRETE>* Instance()
    {
        static CONCRETE inst;
        return &inst;
    }

    static void Reset()
    {
        Instance()->ResetImpl();
    }

    static void BeginEvent(unsigned event) throw (Exception)
    {
        Instance()->BeginEventImpl(event);
    }

    static void EndEvent(unsigned event)
    {
        Instance()->EndEventImpl(event);
    }

    static double GetElapsedTime(unsigned event)
    {
        return Instance()->GetElapsedTimeImpl(event);
    }

    static void Report()
    {
        Instance()->ReportImpl();
    }

    static void Headings()
    {
        Instance()->HeadingsImpl();
    }

    static void Enable()
    {
        Instance()->EnableImpl();
    }

    static void Disable()
    {
        Instance()->DisableImpl();
    }

    static bool IsEnabled()
    {
        return Instance()->IsEnabledImpl();
    }

protected:

    GenericEventHandler()
    {
        mEnabled = true;
        mInUse = false;
        mWallTime.resize(NUM_EVENTS, 0.0);
        mHasBegun.resize(NUM_EVENTS, false);
    }

private:

    void ResetImpl()
    {
        for (unsigned event=0; event<NUM_EVENTS; event++)
        {
            mWallTime[event] = 0.0;
            mHasBegun[event] = false;
        }
        Enable();
        mInUse = false;
    }

    void BeginEventImpl(unsigned event) throw (Exception)
    {
        if (!mEnabled)
        {
            return;
        }
#ifdef CHASTE_EVENT_BARRIERS
        PetscTools::Barrier("BeginEvent");
#endif
        mInUse = true;
        assert(event<NUM_EVENTS);
        // Check that we are recording the total
        if (event != NUM_EVENTS-1) // If use <, Intel complains when NUM_EVENTS==1
        {
            if (!mHasBegun[NUM_EVENTS-1])
            {
                // Silently open the "total" event
                BeginEvent(NUM_EVENTS-1);
            }
        }
        if (mHasBegun[event])
        {
            std::string msg;
            msg += "The event associated with the counter for '";
            msg += CONCRETE::EventName[event];
            msg += "' had already begun when BeginEvent was called.";
            std::cerr << msg << std::endl << std::flush;
            Disable();
            return;
        }
        mWallTime[event] -= GetWallTime();
        mHasBegun[event] = true;
        //std::cout << PetscTools::GetMyRank()<<": Beginning " << EVENT_NAME[event] << " @ " << (clock()/1000) << std::endl;
    }

    void EndEventImpl(unsigned event)
    {
        assert(event<NUM_EVENTS);
        if (!mEnabled)
        {
            return;
        }
#ifdef CHASTE_EVENT_BARRIERS
        PetscTools::Barrier("EndEvent");
#endif
        if (!mHasBegun[event])
        {
            std::string msg;
            msg += "Error: The event associated with the counter for '";
            msg += CONCRETE::EventName[event];
            msg += "' had not begun when EndEvent was called.";
            EXCEPTION(msg);
        }
        mWallTime[event] += GetWallTime();
        mHasBegun[event] = false;
        //std::cout << PetscTools::GetMyRank()<<": Ending " << EVENT_NAME[event] << " @ " << (clock()/1000) << std::endl;
    }

    double GetElapsedTimeImpl(unsigned event)
    {
        assert(event<NUM_EVENTS);
        if (!mEnabled)
        {
            return 0.0;
        }
        double time;
        if (mHasBegun[event])
        {
            time =  mWallTime[event] + GetWallTime();
        }
        else
        {
            time = mWallTime[event];
        }
        return ConvertWallTimeToMilliseconds(time);
    }

    void ReportImpl()
    {
        if (!mEnabled)
        {
            EXCEPTION("Asked to report on a disabled event handler.  Check for contributory errors above.");
        }
        if (!mInUse)
        {
            EXCEPTION("Asked to report on an event handler which is set to zero.");
        }
        // Check that all events are finished
        for (unsigned event=0; event<NUM_EVENTS; event++)
        {
            if (mHasBegun[event])
            {
                // Silently close event
                EndEvent(event);
            }
        }
        const unsigned top_event = NUM_EVENTS-1;
        double total = ConvertWallTimeToSeconds(mWallTime[top_event]);

        // Make the output precision depend on total run time
        const char* format;
        if (total > 999999.0)      // 11.5 days
        {
            format = "%8.0f ";     // will allow up to 115 days before columns unaligned
        }
        else if (total > 9999.0)   // 2.7 hours
        {
            format = "%8.1f ";
        }
        else
        {
            format = "%8.3f ";
        }

        PetscTools::BeginRoundRobin();
        {
            std::cout.flush();
            if (PetscTools::IsParallel())
            {
                // Report the process number at the beginning of the line
                printf("%3i: ", PetscTools::GetMyRank()); //5 chars
            }
            for (unsigned event=0; event<NUM_EVENTS; event++)
            {
                const double secs = ConvertWallTimeToSeconds(mWallTime[event]);
                printf(format, secs);
                printf("(%3.0f%%)  ", total == 0.0 ? 0.0 : (secs/total*100.0));
            }
            std::cout << "(seconds) \n";
        }
        PetscTools::EndRoundRobin();

        // If there is a collection of processes then report an average
        if (PetscTools::IsParallel())
        {
            double total_cpu_time[NUM_EVENTS];
            MPI_Reduce(&mWallTime[0], total_cpu_time, NUM_EVENTS, MPI_DOUBLE, MPI_SUM, 0, PETSC_COMM_WORLD);
            if (PetscTools::AmMaster())
            {
                total = ConvertWallTimeToSeconds(total_cpu_time[top_event]);
                printf("avg: "); //5 chars
                for (unsigned event=0; event<NUM_EVENTS; event++)
                {
                    const double secs = ConvertWallTimeToSeconds(total_cpu_time[event]);
                    printf(format, secs/PetscTools::GetNumProcs());
                    printf("(%3.0f%%)  ", total == 0.0 ? 0.0 : (secs/total*100.0));
                }
                std::cout << "(seconds) \n";
            }

            double max_cpu_time[NUM_EVENTS];
            MPI_Reduce(&mWallTime[0], max_cpu_time, NUM_EVENTS, MPI_DOUBLE, MPI_MAX, 0, PETSC_COMM_WORLD);
            if (PetscTools::AmMaster())
            {
                total = ConvertWallTimeToSeconds(max_cpu_time[top_event]);
                printf("max: "); //5 chars
                for (unsigned event=0; event<NUM_EVENTS; event++)
                {
                    const double secs = ConvertWallTimeToSeconds(max_cpu_time[event]);
                    printf(format, secs);
                    printf("(%3.0f%%)  ", total == 0.0 ? 0.0 : (secs/total*100.0));
                }
                std::cout << "(seconds) \n";
            }
        }
        std::cout.flush();
        PetscTools::Barrier();
        std::cout.flush();

        Reset();
    }

    void HeadingsImpl()
    {
        // Make sure that all output (on all processes) is flushed
        std::cout.flush();
        PetscTools::Barrier();
        std::cout.flush();
        if (PetscTools::AmMaster())
        {
            if (PetscTools::IsParallel())
            {
                // Report the process number at the beginning of the line
                printf("Proc "); //5 chars
            }
            for (unsigned event=0; event<NUM_EVENTS; event++)
            {
                printf("%15s%2s", CONCRETE::EventName[event], "");
            }
            std::cout << "\n";
            std::cout.flush();
        }
    }

    void EnableImpl()
    {
        mEnabled = true;
    }

    void DisableImpl()
    {
        mEnabled = false;
    }

    bool IsEnabledImpl()
    {
        return mEnabled;
    }
};

#endif /*GENERICEVENTHANDLER_HPP_*/