reference_counter.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library 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.
 
// This library 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.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_REFERENCE_COUNTER_H
#define LIBMESH_REFERENCE_COUNTER_H
 
// Local includes
#include "libmesh/libmesh_config.h"
#include "libmesh/threads.h"
#include "libmesh/libmesh.h" // libMesh::on_command_line
#include "libmesh/libmesh_exceptions.h" // libmesh_try, libmesh_catch
 
// C++ includes
#include <iostream>
#include <string>
#include <map>
#include <exception> // std::terminate
 
namespace libMesh
{
 
class ReferenceCounter
{
protected:
 
  ReferenceCounter ();
  ReferenceCounter (const ReferenceCounter &);
 
 
  ReferenceCounter(ReferenceCounter && other) noexcept;
 
public:
 
  ~ReferenceCounter ();
 
  static std::string get_info ();
 
  static void print_info (std::ostream & out_stream = libMesh::out);
 
  static unsigned int n_objects ()
  { return _n_objects; }
 
  static void enable_print_counter_info();
  static void disable_print_counter_info();
 
 
protected:
 
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
  void increment_constructor_count (const std::string & name) noexcept;
 
  void increment_destructor_count (const std::string & name) noexcept;
 
  typedef std::map<std::string, std::pair<unsigned int,
                                          unsigned int>> Counts;
 
  static Counts _counts;
 
#endif
 
  static Threads::atomic<unsigned int> _n_objects;
 
  static Threads::spin_mutex _mutex;
 
  static bool _enable_print_counter;
};
 
 
 
// ------------------------------------------------------------
// ReferenceCounter class inline methods
inline ReferenceCounter::ReferenceCounter()
{
  ++_n_objects;
}
 
 
 
inline ReferenceCounter::ReferenceCounter(const ReferenceCounter & /*other*/)
{
  ++_n_objects;
}
 
 
 
inline ReferenceCounter::ReferenceCounter(ReferenceCounter && /*other*/) noexcept
{
  ++_n_objects;
}
 
 
 
inline ReferenceCounter::~ReferenceCounter()
{
  --_n_objects;
}
 
 
 
 
 
 
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
inline
void ReferenceCounter::increment_constructor_count (const std::string & name) noexcept
{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}
#endif
 
 
 
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
inline
void ReferenceCounter::increment_destructor_count (const std::string & name) noexcept
{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}
#endif
 
 
} // namespace libMesh
 
 
#endif // LIBMESH_REFERENCE_COUNTER_H