2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2013-2017 Chukong Technologies
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2024-03-07 08:47:00 +08:00
|
|
|
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#include "base/Object.h"
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "base/AutoreleasePool.h"
|
|
|
|
#include "base/Macros.h"
|
|
|
|
#include "base/ScriptSupport.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
2021-12-25 10:04:45 +08:00
|
|
|
# include <algorithm> // std::find
|
|
|
|
# include <thread>
|
|
|
|
# include <mutex>
|
|
|
|
# include <vector>
|
2019-11-23 20:27:39 +08:00
|
|
|
#endif
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
|
|
|
static void trackRef(Object* ref);
|
|
|
|
static void untrackRef(Object* ref);
|
2019-11-23 20:27:39 +08:00
|
|
|
#endif
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
Object::Object()
|
|
|
|
: _referenceCount(1) // when the Object is created, the reference count of it is 1
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2021-12-25 10:04:45 +08:00
|
|
|
, _luaID(0)
|
2019-11-23 20:27:39 +08:00
|
|
|
#endif
|
|
|
|
{
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
static unsigned int uObjectCount = 0;
|
2021-12-25 10:04:45 +08:00
|
|
|
_ID = ++uObjectCount;
|
2019-11-23 20:27:39 +08:00
|
|
|
#endif
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
2019-11-23 20:27:39 +08:00
|
|
|
trackRef(this);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
Object::~Object()
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
ScriptEngineProtocol* pEngine = ScriptEngineManager::getInstance()->getScriptEngine();
|
|
|
|
if (pEngine != nullptr && _luaID)
|
|
|
|
{
|
|
|
|
// if the object is referenced by Lua engine, remove it
|
|
|
|
pEngine->removeScriptObjectByObject(this);
|
|
|
|
}
|
2022-07-16 10:43:05 +08:00
|
|
|
#endif // AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
2019-11-23 20:27:39 +08:00
|
|
|
if (_referenceCount != 0)
|
|
|
|
untrackRef(this);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
void Object::retain()
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
2022-07-16 10:43:05 +08:00
|
|
|
AXASSERT(_referenceCount > 0, "reference count should be greater than 0");
|
2019-11-23 20:27:39 +08:00
|
|
|
++_referenceCount;
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
void Object::release()
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
2022-07-16 10:43:05 +08:00
|
|
|
AXASSERT(_referenceCount > 0, "reference count should be greater than 0");
|
2019-11-23 20:27:39 +08:00
|
|
|
--_referenceCount;
|
|
|
|
|
|
|
|
if (_referenceCount == 0)
|
|
|
|
{
|
2022-08-08 18:02:17 +08:00
|
|
|
#if defined(_AX_DEBUG) && (_AX_DEBUG > 0)
|
2019-11-23 20:27:39 +08:00
|
|
|
auto poolManager = PoolManager::getInstance();
|
|
|
|
if (!poolManager->getCurrentPool()->isClearing() && poolManager->isObjectInPools(this))
|
|
|
|
{
|
2024-05-03 22:15:08 +08:00
|
|
|
// Trigger an assert if the reference count is 0 but the Object is still in autorelease pool.
|
2019-11-23 20:27:39 +08:00
|
|
|
// This happens when 'autorelease/release' were not used in pairs with 'new/retain'.
|
|
|
|
//
|
|
|
|
// Wrong usage (1):
|
|
|
|
//
|
2024-05-03 22:15:08 +08:00
|
|
|
// auto obj = Node::create(); // Object = 1, but it's an autorelease Object which means it was in the
|
2021-12-25 10:04:45 +08:00
|
|
|
// autorelease pool. obj->autorelease(); // Wrong: If you wish to invoke autorelease several times, you
|
|
|
|
// should retain `obj` first.
|
2019-11-23 20:27:39 +08:00
|
|
|
//
|
|
|
|
// Wrong usage (2):
|
|
|
|
//
|
|
|
|
// auto obj = Node::create();
|
2024-05-03 22:15:08 +08:00
|
|
|
// obj->release(); // Wrong: obj is an autorelease Object, it will be released when clearing current pool.
|
2019-11-23 20:27:39 +08:00
|
|
|
//
|
|
|
|
// Correct usage (1):
|
|
|
|
//
|
|
|
|
// auto obj = Node::create();
|
|
|
|
// |- new Node(); // `new` is the pair of the `autorelease` of next line
|
|
|
|
// |- autorelease(); // The pair of `new Node`.
|
|
|
|
//
|
|
|
|
// obj->retain();
|
|
|
|
// obj->autorelease(); // This `autorelease` is the pair of `retain` of previous line.
|
|
|
|
//
|
|
|
|
// Correct usage (2):
|
|
|
|
//
|
|
|
|
// auto obj = Node::create();
|
|
|
|
// obj->retain();
|
|
|
|
// obj->release(); // This `release` is the pair of `retain` of previous line.
|
2022-07-16 10:43:05 +08:00
|
|
|
AXASSERT(false, "The reference shouldn't be 0 because it is still in autorelease pool.");
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
2019-11-23 20:27:39 +08:00
|
|
|
untrackRef(this);
|
|
|
|
#endif
|
|
|
|
delete this;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
Object* Object::autorelease()
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
PoolManager::getInstance()->getCurrentPool()->addObject(this);
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
unsigned int Object::getReferenceCount() const
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
return _referenceCount;
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#if AX_OBJECT_LEAK_DETECTION
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
static std::vector<Object*> __refAllocationList;
|
2019-11-23 20:27:39 +08:00
|
|
|
static std::mutex __refMutex;
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
void Object::printLeaks()
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> refLockGuard(__refMutex);
|
2024-05-03 22:15:08 +08:00
|
|
|
// Dump Object object memory leaks
|
2019-11-23 20:27:39 +08:00
|
|
|
if (__refAllocationList.empty())
|
|
|
|
{
|
2024-05-03 22:15:08 +08:00
|
|
|
AXLOGI("[memory] All Object objects successfully cleaned up (no leaks detected).\n");
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2024-05-03 22:15:08 +08:00
|
|
|
AXLOGI("[memory] WARNING: {} objects still active in memory.\n", (int)__refAllocationList.size());
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
for (const auto& ref : __refAllocationList)
|
|
|
|
{
|
2022-07-16 10:43:05 +08:00
|
|
|
AX_ASSERT(ref);
|
2019-11-23 20:27:39 +08:00
|
|
|
const char* type = typeid(*ref).name();
|
2024-05-03 22:15:08 +08:00
|
|
|
AXLOGI("[memory] LEAK: object '{}' still active with reference count {}.\n", (type ? type : ""),
|
2021-12-25 10:04:45 +08:00
|
|
|
ref->getReferenceCount());
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
static void trackRef(Object* ref)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> refLockGuard(__refMutex);
|
2022-07-16 10:43:05 +08:00
|
|
|
AXASSERT(ref, "Invalid parameter, ref should not be null!");
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
// Create memory allocation record.
|
2022-08-08 13:18:33 +08:00
|
|
|
__refAllocationList.emplace_back(ref);
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
static void untrackRef(Object* ref)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> refLockGuard(__refMutex);
|
|
|
|
auto iter = std::find(__refAllocationList.begin(), __refAllocationList.end(), ref);
|
|
|
|
if (iter == __refAllocationList.end())
|
|
|
|
{
|
2024-03-07 08:47:00 +08:00
|
|
|
AXLOGI("[memory] CORRUPTION: Attempting to free ({}) with invalid ref tracking record.\n", typeid(*ref).name());
|
2019-11-23 20:27:39 +08:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
__refAllocationList.erase(iter);
|
|
|
|
}
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#endif // #if AX_OBJECT_LEAK_DETECTION
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|