mirror of
https://github.com/pybind/pybind11.git
synced 2026-05-11 17:00:34 +00:00
Improve constructor/destructor tracking
This commit rewrites the examples that look for constructor/destructor calls to do so via static variable tracking rather than output parsing. The added ConstructorStats class provides methods to keep track of constructors and destructors, number of default/copy/move constructors, and number of copy/move assignments. It also provides a mechanism for storing values (e.g. for value construction), and then allows all of this to be checked at the end of a test by getting the statistics for a C++ (or python mapping) class. By not relying on the precise pattern of constructions/destructions, but rather simply ensuring that every construction is matched with a destruction on the same object, we ensure that everything that gets created also gets destroyed as expected. This replaces all of the various "std::cout << whatever" code in constructors/destructors with `print_created(this)`/`print_destroyed(this)`/etc. functions which provide similar output, but now has a unified format across the different examples, including a new ### prefix that makes mixed example output and lifecycle events easier to distinguish. With this change, relaxed mode is no longer needed, which enables testing for proper destruction under MSVC, and under any other compiler that generates code calling extra constructors, or optimizes away any constructors. GCC/clang are used as the baseline for move constructors; the tests are adapted to allow more move constructors to be evoked (but other types are constructors much have matching counts). This commit also disables output buffering of tests, as the buffering sometimes results in C++ output ending up in the middle of python output (or vice versa), depending on the OS/python version.
This commit is contained in:
@@ -2,15 +2,16 @@
|
||||
#define __OBJECT_H
|
||||
|
||||
#include <atomic>
|
||||
#include "constructor-stats.h"
|
||||
|
||||
/// Reference counted object base class
|
||||
class Object {
|
||||
public:
|
||||
/// Default constructor
|
||||
Object() { }
|
||||
Object() { print_default_created(this); }
|
||||
|
||||
/// Copy constructor
|
||||
Object(const Object &) : m_refCount(0) {}
|
||||
Object(const Object &) : m_refCount(0) { print_copy_created(this); }
|
||||
|
||||
/// Return the current reference count
|
||||
int getRefCount() const { return m_refCount; };
|
||||
@@ -37,11 +38,17 @@ protected:
|
||||
/** \brief Virtual protected deconstructor.
|
||||
* (Will only be called by \ref ref)
|
||||
*/
|
||||
virtual ~Object() { }
|
||||
virtual ~Object() { print_destroyed(this); }
|
||||
private:
|
||||
mutable std::atomic<int> m_refCount { 0 };
|
||||
};
|
||||
|
||||
// Tag class used to track constructions of ref objects. When we track constructors, below, we
|
||||
// track and print out the actual class (e.g. ref<MyObject>), and *also* add a fake tracker for
|
||||
// ref_tag. This lets us check that the total number of ref<Anything> constructors/destructors is
|
||||
// correct without having to check each individual ref<Whatever> type individually.
|
||||
class ref_tag {};
|
||||
|
||||
/**
|
||||
* \brief Reference counting helper
|
||||
*
|
||||
@@ -55,37 +62,43 @@ private:
|
||||
template <typename T> class ref {
|
||||
public:
|
||||
/// Create a nullptr reference
|
||||
ref() : m_ptr(nullptr) { std::cout << "Created empty ref" << std::endl; }
|
||||
ref() : m_ptr(nullptr) { print_default_created(this); track_default_created((ref_tag*) this); }
|
||||
|
||||
/// Construct a reference from a pointer
|
||||
ref(T *ptr) : m_ptr(ptr) {
|
||||
std::cout << "Initialized ref from pointer " << ptr<< std::endl;
|
||||
if (m_ptr) ((Object *) m_ptr)->incRef();
|
||||
|
||||
print_created(this, "from pointer", m_ptr); track_created((ref_tag*) this, "from pointer");
|
||||
|
||||
}
|
||||
|
||||
/// Copy constructor
|
||||
ref(const ref &r) : m_ptr(r.m_ptr) {
|
||||
std::cout << "Initialized ref from ref " << r.m_ptr << std::endl;
|
||||
if (m_ptr)
|
||||
((Object *) m_ptr)->incRef();
|
||||
|
||||
print_copy_created(this, "with pointer", m_ptr); track_copy_created((ref_tag*) this);
|
||||
}
|
||||
|
||||
/// Move constructor
|
||||
ref(ref &&r) : m_ptr(r.m_ptr) {
|
||||
std::cout << "Initialized ref with move from ref " << r.m_ptr << std::endl;
|
||||
r.m_ptr = nullptr;
|
||||
|
||||
print_move_created(this, "with pointer", m_ptr); track_move_created((ref_tag*) this);
|
||||
}
|
||||
|
||||
/// Destroy this reference
|
||||
~ref() {
|
||||
std::cout << "Destructing ref " << m_ptr << std::endl;
|
||||
if (m_ptr)
|
||||
((Object *) m_ptr)->decRef();
|
||||
|
||||
print_destroyed(this); track_destroyed((ref_tag*) this);
|
||||
}
|
||||
|
||||
/// Move another reference into the current one
|
||||
ref& operator=(ref&& r) {
|
||||
std::cout << "Move-assigning ref " << r.m_ptr << std::endl;
|
||||
print_move_assigned(this, "pointer", r.m_ptr); track_move_assigned((ref_tag*) this);
|
||||
|
||||
if (*this == r)
|
||||
return *this;
|
||||
if (m_ptr)
|
||||
@@ -97,7 +110,8 @@ public:
|
||||
|
||||
/// Overwrite this reference with another reference
|
||||
ref& operator=(const ref& r) {
|
||||
std::cout << "Assigning ref " << r.m_ptr << std::endl;
|
||||
print_copy_assigned(this, "pointer", r.m_ptr); track_copy_assigned((ref_tag*) this);
|
||||
|
||||
if (m_ptr == r.m_ptr)
|
||||
return *this;
|
||||
if (m_ptr)
|
||||
@@ -110,7 +124,8 @@ public:
|
||||
|
||||
/// Overwrite this reference with a pointer to another object
|
||||
ref& operator=(T *ptr) {
|
||||
std::cout << "Assigning ptr " << ptr << " to ref" << std::endl;
|
||||
print_values(this, "assigned pointer"); track_values((ref_tag*) this, "assigned pointer");
|
||||
|
||||
if (m_ptr == ptr)
|
||||
return *this;
|
||||
if (m_ptr)
|
||||
|
||||
Reference in New Issue
Block a user