profiling_information.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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.
 *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef PROFILING_INFORMATION_HPP
#define PROFILING_INFORMATION_HPP

#include "config_HAVE_UNORDERED.hpp"

#include "basic_block.hpp"

#include "graph.hpp"

#include "custom_map.hpp"
#include "custom_set.hpp"

#include "refcount.hpp"

CONSTREF_FORWARD_DECL(BBGraph);
CONSTREF_FORWARD_DECL(Loop);
class xml_element;

#if HAVE_UNORDERED
class PathProfilingInformation
    : public CustomUnorderedMap<unsigned int, std::map<CustomOrderedSet<unsigned int>, long double>>
{
};
#else
class PathProfilingInformation : public std::map<unsigned int, std::map<CustomOrderedSet<unsigned int>, long double>>
{
};
#endif

#if HAVE_UNORDERED
class BBExecutions : public CustomUnorderedMap<vertex, unsigned long long int>
{
 public:
   explicit BBExecutions(const BBGraphConstRef bb_graph);
};
#else
class BBExecutions : public std::map<vertex, unsigned long long int, BBVertexSorter>
{
 public:
   explicit BBExecutions(const BBGraphConstRef bb_graph);
};
#endif

#if HAVE_UNORDERED
class BBEdgeExecutions : public CustomUnorderedMap<EdgeDescriptor, unsigned long long int>
{
 public:
   explicit BBEdgeExecutions(const BBGraphConstRef bb_graph);
};
#else
class BBEdgeExecutions : public std::map<EdgeDescriptor, unsigned long long int, BBEdgeSorter>
{
 public:
   explicit BBEdgeExecutions(const BBGraphConstRef bb_graph);
};
#endif

#if HAVE_UNORDERED
class AvgIterations : public CustomUnorderedMap<unsigned int, long double>
{
};
#else
class AvgIterations : public std::map<unsigned int, long double>
{
};
#endif

#if HAVE_UNORDERED
class Iterations : public CustomUnorderedMap<unsigned int, unsigned long long int>
{
};
#else
class Iterations : public std::map<unsigned int, unsigned long long int>
{
};
#endif

class ProfilingInformation
{
 private:
   friend class BasicBlocksProfiling;
   friend class hpp_profiling;
   friend class LoopsProfiling;
   friend class probability_path;
   friend class HostProfiling;
   friend class read_profiling_data;
   friend class tp_profiling;

   PathProfilingInformation path_profiling;

   BBExecutions bb_executions;

   BBEdgeExecutions edge_executions;

   AvgIterations avg_iterations;

   Iterations abs_iterations;

   Iterations max_iterations;

 public:
   explicit ProfilingInformation(const BBGraphConstRef bb_graph);

   ~ProfilingInformation();

   const PathProfilingInformation& GetPathProfiling() const;

   unsigned long long int GetBBExecutions(const vertex bb_vertex) const;

   unsigned long long int GetEdgeExecutions(const EdgeDescriptor edge) const;

   long double GetLoopAvgIterations(const unsigned int loop_id) const;

   unsigned long long int GetLoopMaxIterations(const unsigned int loop_id) const;

   unsigned long long GetLoopAbsIterations(const unsigned int loop_id) const;

   long double GetLoopAvgIterations(const LoopConstRef loop) const;

   unsigned long long int GetLoopMaxIterations(const LoopConstRef loop) const;

   unsigned long long GetLoopAbsIterations(const LoopConstRef loop) const;

   void WriteToXml(xml_element* root, const BBGraphConstRef fcfg) const;

   void Clear();
};

using ProfilingInformationRef = refcount<ProfilingInformation>;

#endif