crash_logger.hpp

Go to the documentation of this file.

// Copyright (c) 2016-2018 Commissariat à l'énergie atomique et aux énergies alternatives (CEA)
// Copyright (c) 2016-2018 Centre national de la recherche scientifique (CNRS)
// Copyright (c) 2018-2020 Simons Foundation
//
// 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 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 may obtain a copy of the License at
//     https://www.gnu.org/licenses/gpl-3.0.txt
//
// Authors: Olivier Parcollet, Nils Wentzell

 
#pragma once
 
#include "./scope_guard.hpp"
#include "./typeid_name.hpp"
 
#include <h5/h5.hpp>
 
#include <functional>
#include <iostream>
#include <string>
#include <utility>
#include <vector>
 
namespace triqs::utility {

  class crash_logger {
    std::string filename_;
    std::vector<scope_guard<std::function<void()>>> guards;
    std::vector<std::string> names;
 
    public:
    crash_logger(std::string filename) : filename_(std::move(filename)) {}

    crash_logger(const crash_logger &) = delete;

    crash_logger(crash_logger &&) = default;

    crash_logger &operator=(const crash_logger &) = delete;

    crash_logger &operator=(crash_logger &&x) noexcept {
      using std::swap;
      swap(guards, x.guards);
      swap(names, x.names);
      return *this;
    }

    template <typename T> crash_logger &operator()(T const &obj, std::string name) {
      names.push_back(name);
      guards.emplace_back([&obj, this, name]() {
        using h5::h5_write; // ensure proper ADL for scalar types
        try {
          h5_write(h5::group(h5::file(this->filename_.c_str(), 'a')), name, obj);
        } catch (...) {
          std::cerr << "An exception has occurred in crash_logger for an object of type " << typeid_name(obj) << " named " << name << std::endl;
        }
      });
      return *this;
    }

    ~crash_logger() noexcept {
      if ((guards.size() > 0) && (guards.front().active())) {
        std::cerr << "crash_logger : I am destroyed without being dismissed. Dumping the objects : ";
        for (auto &x : names) std::cerr << "\"" << x << "\" ";
        std::cerr << std::endl;
        h5::file(this->filename_.c_str(), 'w'); // create the file
      }
    }

    void dismiss() {
      for (auto &g : guards) g.dismiss();
    }
  };
 
} // namespace triqs::utility