profile_node.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015:  G-CSC, Goethe University Frankfurt
 * Author: Martin Rupp
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H_UG__PROFILE_NODE__
#define __H_UG__PROFILE_NODE__
 
#include <string>
#include <vector>
#include <sstream>
 
namespace ug
{
 
class UGProfileNode
#if SHINY_PROFILER
: public Shiny::ProfileNode
#endif
{
public:
  double get_avg_entry_count() const;
 
  double get_avg_self_time_ms() const;
 
  double get_avg_total_time_ms() const;
 
  double get_avg_self_time() const;
 
  double get_avg_total_time() const;
 
  double get_self_mem() const;
  double get_total_mem() const;
 
  std::string call_tree(double dSkipMarginal) const;
  std::string call_tree() const { return call_tree(0.0);  }
 
  std::string child_self_time_sorted(double dSkipMarginal) const;
  std::string child_self_time_sorted() const { return child_self_time_sorted(0.0); }
 
  std::string total_time_sorted(double dSkipMarginal) const;
  std::string total_time_sorted() const { return total_time_sorted(0.0); }
 
 
  std::string child_self_memory_sorted(double dSkipMarginal) const;
  std::string child_self_memory_sorted() const { return child_self_memory_sorted(0.0); }
 
  std::string total_memory_sorted(double dSkipMarginal) const;
  std::string total_memory_sorted() const { return total_memory_sorted(0.0); }
 
 
  std::string entry_count_sorted(double dSkipMarginal) const;
  std::string entry_count_sorted() const { return entry_count_sorted(0.0); }
 
  std::string groups() const;
 
  bool valid() const;
 
  static const UGProfileNode *get_root();
 
  static void CheckForTooSmallNodes();
#if SHINY_PROFILER
 
public:
  const UGProfileNode *get_first_child() const;
  const UGProfileNode *get_last_child() const;
  const UGProfileNode *get_next_sibling() const;
  const UGProfileNode *find_next_in_tree() const;
 
 
  void PDXML_rec_write(std::ostream &s) const;
 
  std::string print_node(double fullMs, double fullMem, size_t offset=0) const;
 
  void rec_add_nodes(std::vector<const UGProfileNode*> &nodes) const;
 
  static void log_header(std::stringstream &s, const char *name);
private:
  void check_for_too_small_nodes(double fullMs, std::map<std::string, const UGProfileNode *> &list) const;
 
  std::string get_mem_info(double fullMem) const;
 
 
  void rec_print(double fullMs, double fullMem, std::stringstream &s, size_t offset, double dSkipMarginal) const;
 
 
  std::string print_child_sorted(const char *name, bool sortFunction(const UGProfileNode *a, const UGProfileNode *b),
      double dSkipMarginal) const;
 
  // sort functions
  static bool self_time_sort(const UGProfileNode *a, const UGProfileNode *b);
  static bool total_time_sort(const UGProfileNode *a, const UGProfileNode *b);
  static bool self_memory_sort(const UGProfileNode *a, const UGProfileNode *b);
  static bool total_memory_sort(const UGProfileNode *a, const UGProfileNode *b);
  static bool entry_count_sort(const UGProfileNode *a, const UGProfileNode *b); 
#endif
 
  // do NOT add variables or virtual functions here (see above).
};
 
 
class UGProfileNodeNull
: public UGProfileNode
{
  public:
       static UGProfileNodeNull* getInstance()
       {
           static UGProfileNodeNull instance;
           return &instance;
       }
 
   private:
       UGProfileNodeNull() {};
       UGProfileNodeNull(UGProfileNodeNull const&); // do not implement
       void operator=(UGProfileNodeNull const&); // do not implement
};
 
#define PROFILER_NULL_NODE UGProfileNodeNull::getInstance()
 
 
const UGProfileNode *GetProfileNode(const char *name);
const UGProfileNode *GetProfileNode(const char *name, const UGProfileNode *node);
bool GetProfilerAvailable();
 
void WriteProfileDataXML(const char *filename);
 
 
void WriteProfileDataXML(const char *filename, int procId);
 
void WriteCallLog(const char *filename);
void WriteCallLog(const char *filename, int procId);
 
}
 
 
#endif /* __H_UG__PROFILE_NODE__ */