debugging_supports.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * This program 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_DEBUGGING_DEBUGGING_SUPPORTS_HPP_
#define FOEDUS_DEBUGGING_DEBUGGING_SUPPORTS_HPP_

#include <string>
#include <vector>

#include "foedus/cxx11.hpp"
#include "foedus/fwd.hpp"
#include "foedus/initializable.hpp"
#include "foedus/debugging/debugging_options.hpp"

namespace foedus {
namespace debugging {
class DebuggingSupports CXX11_FINAL : public DefaultInitializable {
 public:
  struct PapiCounters {
    long long int counters_[128];  // NOLINT[runtime/int](PAPI requirement)
  };

  DebuggingSupports() CXX11_FUNC_DELETE;
  explicit DebuggingSupports(Engine* engine) : engine_(engine) {}
  ErrorStack  initialize_once() CXX11_OVERRIDE;
  ErrorStack  uninitialize_once() CXX11_OVERRIDE;

  void                set_debug_log_to_stderr(bool value);
  void                set_debug_log_stderr_threshold(DebuggingOptions::DebugLogLevel level);
  void                set_debug_log_min_threshold(DebuggingOptions::DebugLogLevel level);
  void                set_verbose_log_level(int verbose);
  void                set_verbose_module(const std::string &module, int verbose);

  ErrorStack          start_profile(const std::string& output_file);
  void                stop_profile();

  void                start_papi_counters();
  void                stop_papi_counters();

  const PapiCounters& get_papi_counters() const { return papi_counters_; }
  static std::vector<std::string> describe_papi_counters(const PapiCounters& counters);

 private:
  void                initialize_glog();
  void                uninitialize_glog();

  Engine* const           engine_;

  bool                    papi_enabled_;
  PapiCounters            papi_counters_;
};
}  // namespace debugging
}  // namespace foedus
#endif  // FOEDUS_DEBUGGING_DEBUGGING_SUPPORTS_HPP_