base/src/refbase.cpp

/*
 * Copyright (c) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "refbase.h"
#include "utils_log.h"
#ifdef DEBUG_REFBASE
#include <unistd.h>
#endif

namespace OHOS {

void RefCounter::RefBaseDebugPrint([[maybe_unused]] int curCount,
    [[maybe_unused]] const void* caller,
    [[maybe_unused]] const void* objectId,
    [[maybe_unused]] const char* operation,
    [[maybe_unused]] const char* countType)
{
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    if (this->enableTrack) {
        UTILS_LOGT(this->domainId_, "curCount: %{public}d, operation: %{public}s, countType: %{public}s",
            curCount, operation, countType);
    }
#endif
}

WeakRefCounter::WeakRefCounter(RefCounter *counter, void *cookie)
    : atomicWeak_(0), refCounter_(counter), cookie_(cookie)
{
    if (refCounter_ != nullptr) {
        refCounter_->IncRefCount();
    }
}

WeakRefCounter::~WeakRefCounter()
{
    if (refCounter_ != nullptr) {
        refCounter_->DecRefCount();
    }
}

int WeakRefCounter::GetWeakRefCount() const
{
    return atomicWeak_.load(std::memory_order_relaxed);
}

void* WeakRefCounter::GetRefPtr()
{
    if ((cookie_ != nullptr) && (!refCounter_->IsRefPtrValid())) {
        cookie_ = nullptr;
    }
    return cookie_;
}

void WeakRefCounter::IncWeakRefCount(const void *objectId)
{
    if (atomicWeak_.fetch_add(1, std::memory_order_relaxed) == 0) {
        refCounter_->IncWeakRefCount(objectId);
    }
}

void WeakRefCounter::DecWeakRefCount(const void *objectId)
{
    if (atomicWeak_.fetch_sub(1, std::memory_order_release) == 1) {
        refCounter_->DecWeakRefCount(objectId);
        delete this;
    }
}

bool WeakRefCounter::AttemptIncStrongRef(const void *objectId)
{
    int unuse = 0;
    return refCounter_->AttemptIncStrongRef(objectId, unuse);
}

#if ((defined DEBUG_REFBASE) && (!defined PRINT_TRACK_AT_ONCE))
// RefTracker is a debug tool, used to record the trace of RefBase.
// RefTracker will save the information about the count of RefBase,
// including the pointer of sptr/wptr(The pointer of itself, not the pointer
// it manages), the amount of strong/weak/refcout and the PID&TID.
// The Tracker can live with RefCounter.
// User should keep thread-safety of RefTracker.
class RefTracker {
public:
    RefTracker(RefTracker* exTracker, const void* id, int strong, int weak, int ref, int pid, int tid);

    void PrintTrace(const void* refCounterPtr);

    RefTracker* PopTrace(const void* refCounterPtr);

private:
    const void* ptrID;
    int strongRefCnt;
    int weakRefCnt;
    int refCnt;
    int PID;
    int TID;
    RefTracker* exTrace;
};

RefTracker::RefTracker(RefTracker* exTracker, const void* id, int strong, int weak, int ref, int pid, int tid)
    : ptrID (id), strongRefCnt (strong), weakRefCnt (weak), refCnt (ref), PID (pid), TID (tid), exTrace (exTracker)
{
}

void RefTracker::PrintTrace(const void* refCounterPtr)
{
    UTILS_LOGI("strong: %{public}d weak: %{public}d, refcnt: %{public}d PID: %{public}d TID: %{public}d",
        strongRefCnt, weakRefCnt, refCnt, PID, TID);
}

RefTracker* RefTracker::PopTrace(const void* refCounterPtr)
{
    RefTracker* ref = exTrace;
    PrintTrace(refCounterPtr);
    delete this;
    return ref;
}
#endif

#ifdef DEBUG_REFBASE
#ifdef PRINT_TRACK_AT_ONCE
void RefCounter::EnableTrackerWithDomainId(unsigned int domainId)
{
    std::lock_guard<std::mutex> lock(trackerMutex);
    this->domainId_ = domainId;
    enableTrack = true;
}
#else
void RefCounter::GetNewTrace(const void* objectId)
{
    std::lock_guard<std::mutex> lock(trackerMutex);
    RefTracker* newTracker = new RefTracker(refTracker, objectId, atomicStrong_,
        atomicWeak_, atomicRefCount_, getpid(), gettid());
    refTracker = newTracker;
}

void RefCounter::PrintTracker()
{
    std::lock_guard<std::mutex> lock(trackerMutex);
    if (refTracker) {
        UTILS_LOGI("Start backtrace");
        while (refTracker) {
            refTracker = refTracker->PopTrace(this);
        }
        UTILS_LOGI("End backtrace");
    }
}
#endif

#ifndef TRACK_ALL
void RefCounter::EnableTracker()
{
    std::lock_guard<std::mutex> lock(trackerMutex);
#ifndef PRINT_TRACK_AT_ONCE
    enableTrack = true;
#endif
}
#endif

#endif

void RefCounter::DebugRefBase([[maybe_unused]]const void* objectId)
{
#ifdef DEBUG_REFBASE
    if (enableTrack) {
#ifndef PRINT_TRACK_AT_ONCE
        GetNewTrace(objectId);
#endif
    }
#endif
}

RefCounter::RefCounter()
    : atomicStrong_(INITIAL_PRIMARY_VALUE), atomicWeak_(0), atomicRefCount_(0), atomicFlags_(0), atomicAttempt_(0)
{
}

int RefCounter::GetRefCount()
{
    return atomicRefCount_.load(std::memory_order_relaxed);
}

void RefCounter::IncRefCount()
{
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    int curCount = atomicRefCount_.fetch_add(1, std::memory_order_relaxed);
    RefBaseDebugPrint(curCount, __builtin_return_address(0), nullptr, "++", "atomicRefCount_");
#else
    atomicRefCount_.fetch_add(1, std::memory_order_relaxed);
#endif
}

void RefCounter::DecRefCount()
{
    if (atomicRefCount_.load(std::memory_order_relaxed) > 0) {
        int curCount = atomicRefCount_.fetch_sub(1, std::memory_order_release);
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
        RefBaseDebugPrint(curCount, __builtin_return_address(0), nullptr, "++", "atomicRefCount_");
#endif
        if (curCount == 1) {
            delete (this);
        }
    }
}

void RefCounter::SetCallback(const RefPtrCallback& callback)
{
    callback_ = callback;
}

void RefCounter::RemoveCallback()
{
    callback_ = nullptr;
}

bool RefCounter::IsRefPtrValid()
{
    return callback_ != nullptr;
}

#ifdef OHOS_PLATFORM
void RefCounter::SetCanPromote(const CanPromote &canPromote)
{
    canPromote_ = canPromote;
}

void RefCounter::RemoveCanPromote()
{
    canPromote_ = nullptr;
}

bool RefCounter::IsCanPromoteValid()
{
    return canPromote_ != nullptr;
}
#endif

RefCounter::~RefCounter()
{
#ifdef DEBUG_REFBASE
    if (enableTrack) {
#ifndef PRINT_TRACK_AT_ONCE
        PrintTracker();
#endif
    }
#endif
}

int RefCounter::IncStrongRefCount(const void* objectId)
{
    DebugRefBase(objectId);
    int curCount = atomicStrong_.load(std::memory_order_relaxed);
    if (curCount >= 0) {
        curCount = atomicStrong_.fetch_add(1, std::memory_order_relaxed);
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
        RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicStrong_");
#endif
        if (curCount == INITIAL_PRIMARY_VALUE) {
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
            int newCurCount = atomicStrong_.fetch_sub(INITIAL_PRIMARY_VALUE, std::memory_order_release);
            RefBaseDebugPrint(newCurCount, __builtin_return_address(0), objectId, "--", "atomicStrong_");
#else
            atomicStrong_.fetch_sub(INITIAL_PRIMARY_VALUE, std::memory_order_release);
#endif
        }
    }

    return curCount;
}

int RefCounter::DecStrongRefCount(const void* objectId)
{
    DebugRefBase(objectId);
    int curCount = GetStrongRefCount();
    if (curCount == INITIAL_PRIMARY_VALUE) {
        // unexpected case: there had never a strong reference.
        UTILS_LOGD("decStrongRef when there is nerver a strong reference");
    } else if (curCount > 0) {
        // we should update the current count here.
        // it may be changed after last operation.
        curCount = atomicStrong_.fetch_sub(1, std::memory_order_release);
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
        RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "--", "atomicStrong_");
#endif
    }

    return curCount;
}

int RefCounter::GetStrongRefCount()
{
    return atomicStrong_.load(std::memory_order_relaxed);
}

int RefCounter::IncWeakRefCount(const void* objectId)
{
    DebugRefBase(objectId);
    int curCount = atomicWeak_.fetch_add(1, std::memory_order_relaxed);
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicWeak_");
#endif
    return curCount;
}

int RefCounter::DecWeakRefCount(const void* objectId)
{
    DebugRefBase(objectId);
    int curCount = GetWeakRefCount();
    if (curCount > 0) {
        curCount = atomicWeak_.fetch_sub(1, std::memory_order_release);
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
        RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "--", "atomicWeak_");
#endif
    }

    if (curCount != 1) {
        return curCount;
    }
    std::atomic_thread_fence(std::memory_order_acquire);
    if (IsLifeTimeExtended()) {
        if (callback_) {
            callback_();
        }
    } else {
        // only weak ptr but never had a strong ref, we should do nothing here theoretically. But it may cause a leak.
        if (GetStrongRefCount() == INITIAL_PRIMARY_VALUE) {
            UTILS_LOGW("dec the last weakRef before it had a strong reference, delete refbase to avoid Memory Leak");
            if (callback_) {
                callback_();
            }
        } else {
            // free RefCounter
            DecRefCount();
        }
    }

    return curCount;
}

int RefCounter::GetWeakRefCount()
{
    return atomicWeak_.load(std::memory_order_relaxed);
}

int RefCounter::GetAttemptAcquire()
{
    return atomicAttempt_.load(std::memory_order_relaxed);
}

void RefCounter::SetAttemptAcquire()
{
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    int curCount = atomicAttempt_.fetch_add(1, std::memory_order_relaxed);
    RefBaseDebugPrint(curCount, __builtin_return_address(0), nullptr, "++", "atomicAttempt_");
#else
    (void)atomicAttempt_.fetch_add(1, std::memory_order_relaxed);
#endif
}

bool RefCounter::IsAttemptAcquireSet()
{
    return static_cast<bool>(atomicAttempt_.load(std::memory_order_relaxed) > 0);
}

void RefCounter::ClearAttemptAcquire()
{
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    int curCount = atomicAttempt_.fetch_sub(1, std::memory_order_relaxed);
    RefBaseDebugPrint(curCount, __builtin_return_address(0), nullptr, "--", "atomicAttempt_");
#else
    atomicAttempt_.fetch_sub(1, std::memory_order_relaxed);
#endif
}

void RefCounter::ExtendObjectLifetime()
{
    atomicFlags_.fetch_or(FLAG_EXTEND_LIFE_TIME, std::memory_order_relaxed);
}

bool RefCounter::IsLifeTimeExtended()
{
    return static_cast<bool>(atomicFlags_.load(std::memory_order_relaxed) & FLAG_EXTEND_LIFE_TIME);
}

bool RefCounter::AttemptIncStrongRef(const void *objectId, int &outCount)
{
    int curCount = GetStrongRefCount();
    IncWeakRefCount(objectId);

    // if the object already had strong references.just promoting it.
    while ((curCount > 0) && (curCount != INITIAL_PRIMARY_VALUE)) {
        if (atomicStrong_.compare_exchange_weak(curCount, curCount + 1, std::memory_order_relaxed)) {
            RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicStrong_");
            goto ATTEMPT_SUCCESS;
        }
        // someone else changed the counter.re-acquire the counter value.
        curCount = atomicStrong_.load(std::memory_order_relaxed);
    }

    if ((curCount == INITIAL_PRIMARY_VALUE) && !IsLifeTimeExtended()) {
        // this object has a "normal" life-time,
        while (curCount > 0) {
            if (atomicStrong_.compare_exchange_weak(curCount, curCount + 1, std::memory_order_relaxed)) {
                RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicStrong_");
                goto ATTEMPT_SUCCESS;
            }
            curCount = atomicStrong_.load(std::memory_order_relaxed);
        }
    }

    if (IsLifeTimeExtended()) {
#ifdef OHOS_PLATFORM
        if (!IsCanPromoteValid() || !canPromote_()) {
            return false;
        }
#endif
        curCount = atomicStrong_.fetch_add(1, std::memory_order_relaxed);
        RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicStrong_");
    }

ATTEMPT_SUCCESS:
    if (curCount == INITIAL_PRIMARY_VALUE) {
        outCount = curCount;
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
        int newCurCount = atomicStrong_.fetch_sub(INITIAL_PRIMARY_VALUE, std::memory_order_release);
        RefBaseDebugPrint(newCurCount, __builtin_return_address(0), objectId, "--", "atomicStrong_");
#else
        atomicStrong_.fetch_sub(INITIAL_PRIMARY_VALUE, std::memory_order_release);
#endif
        return true;
    }

    if (curCount < 0 || (!IsLifeTimeExtended() && curCount == 0)) {
        // the object destroyed on strong reference count reduce to zero.
        DecWeakRefCount(objectId);
        return false;
    }

    return true;
}

bool RefCounter::AttemptIncStrong(const void *objectId)
{
    IncWeakRefCount(objectId);
    int curCount = GetStrongRefCount();
    while (curCount > 0) {
        if (atomicStrong_.compare_exchange_weak(curCount, curCount + 1, std::memory_order_relaxed)) {
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
            RefBaseDebugPrint(curCount, __builtin_return_address(0), objectId, "++", "atomicStrong_");
#endif
            break;
        }
        // curCount has been updated.
    }
    if (curCount <= 0) {
        DecWeakRefCount(objectId);
    }
    return curCount > 0;
}

RefBase::RefBase() : refs_(new RefCounter())
{
    refs_->IncRefCount();
    refs_->SetCallback([this] { this->RefPtrCallback(); });
#ifdef OHOS_PLATFORM
    refs_->SetCanPromote([this] { return this->CanPromote(); });
#endif
}

RefBase::RefBase(const RefBase &)
{
    refs_ = new (std::nothrow) RefCounter();
    if (refs_ != nullptr) {
        refs_->IncRefCount();
        refs_->SetCallback([this] { this->RefPtrCallback(); });
#ifdef OHOS_PLATFORM
        refs_->SetCanPromote([this] { return this->CanPromote(); });
#endif
    }
}

#ifdef OHOS_PLATFORM
bool RefBase::CanPromote()
{
    return true;
}
#endif

void RefBase::RefPtrCallback()
{
    delete this;
}

/*
 * The two ends of the assignment are two independent and exclusive,
 * and the application should not share the reference counter.
 * RISK: If there is a reference count on the left of the equal sign,
 * it may cause a reference count exception
 */
RefBase &RefBase::operator=(const RefBase &)
{
    if (refs_ != nullptr) {
        refs_->RemoveCallback();
        refs_->DecRefCount();
    }

    refs_ = new (std::nothrow) RefCounter();
    if (refs_ != nullptr) {
        refs_->IncRefCount();
        refs_->SetCallback([this] { this->RefPtrCallback(); });
#ifdef OHOS_PLATFORM
        refs_->SetCanPromote([this] { return this->CanPromote(); });
#endif
    }

    return *this;
}

RefBase::RefBase(RefBase &&other) noexcept
{
    refs_ = other.refs_;
    other.refs_ = nullptr;
}

RefBase &RefBase::operator=(RefBase &&other) noexcept
{
    if (refs_ == other.refs_) {
        return *this;
    }

    if (refs_ != nullptr) {
        refs_->RemoveCallback();
        refs_->DecRefCount();
    }

    refs_ = other.refs_;
    other.refs_ = nullptr;
    return *this;
}

RefBase::~RefBase()
{
    if (refs_ != nullptr) {
        refs_->RemoveCallback();
        if ((refs_->IsLifeTimeExtended() && refs_->GetWeakRefCount() == 0) ||
             refs_->GetStrongRefCount() == INITIAL_PRIMARY_VALUE) {
            refs_->DecRefCount();
        }
        refs_ = nullptr;
    }
}

void RefBase::ExtendObjectLifetime()
{
    refs_->ExtendObjectLifetime();
}

void RefBase::IncStrongRef(const void *objectId)
{
    if (refs_ == nullptr) {
        return;
    }

    IncWeakRef(objectId);
    const int curCount = refs_->IncStrongRefCount(objectId);
    if (!refs_->IsLifeTimeExtended() && curCount == 0) {
        UTILS_LOGF("RefBase object still incStrongRef after last strong ref");
    }
    if (curCount == INITIAL_PRIMARY_VALUE) {
        OnFirstStrongRef(objectId);
    }
}

void RefBase::CheckIsAttemptAcquireSet(const void *objectId)
{
    if (refs_->IsAttemptAcquireSet()) {
        refs_->ClearAttemptAcquire();
        const int attemptCount = refs_->GetAttemptAcquire();
        if (attemptCount < 0) {
            UTILS_LOGF("Multi-threads trigger illegal decstrong from %{public}d due to AttemptIncStrong in ipc",
                attemptCount);
        }
        refs_->DecStrongRefCount(objectId);
        refs_->DecWeakRefCount(objectId);
    }
}

void RefBase::DecStrongRef(const void *objectId)
{
    if (refs_ == nullptr) {
        return;
    }

    RefCounter * const refs = refs_;
    const int curCount = refs->DecStrongRefCount(objectId);
    if (curCount <= 0) {
        UTILS_LOGF("RefBase object call decStrongRef too many times");
    }
    if (curCount == 1) {
        std::atomic_thread_fence(std::memory_order_acquire);
        OnLastStrongRef(objectId);
        if (!refs->IsLifeTimeExtended()) {
            if (refs->callback_) {
                refs->callback_();
            }
        }
    }

    refs->DecWeakRefCount(objectId);
}

int RefBase::GetSptrRefCount()
{
    if (refs_ == nullptr) {
        return 0;
    }
    return refs_->GetStrongRefCount();
}

WeakRefCounter *RefBase::CreateWeakRef(void *cookie)
{
    if (refs_ != nullptr) {
        return new WeakRefCounter(refs_, cookie);
    }
    return nullptr;
}

void RefBase::IncWeakRef(const void *objectId)
{
    if (refs_ != nullptr) {
        refs_->IncWeakRefCount(objectId);
    }
}

RefCounter *RefBase::GetRefCounter() const
{
    return refs_;
}

void RefBase::DecWeakRef(const void *objectId)
{
    if (refs_ != nullptr) {
        refs_->DecWeakRefCount(objectId);
    }
}

int RefBase::GetWptrRefCount()
{
    if (refs_ == nullptr) {
        return 0;
    }
    return refs_->GetWeakRefCount();
}

bool RefBase::AttemptAcquire(const void *objectId)
{
    if (refs_ == nullptr) {
        return false;
    }

    int count = 0;
    if (refs_->AttemptIncStrongRef(objectId, count)) {
        refs_->SetAttemptAcquire();
        if (count == INITIAL_PRIMARY_VALUE) {
            OnFirstStrongRef(objectId);
        }

        return true;
    }
    return false;
}

bool RefBase::AttemptIncStrongRef(const void *objectId)
{
    if ((refs_ != nullptr) && (OnAttemptPromoted(objectId))) {
        int count = 0;
        bool ret = refs_->AttemptIncStrongRef(objectId, count);
        if (count == INITIAL_PRIMARY_VALUE) {
            OnFirstStrongRef(objectId);
        }
        return ret;
    }

    return false;
}

bool RefBase::AttemptIncStrong(const void *objectId)
{
    if (refs_ == nullptr) {
        return false;
    }
    if (refs_->AttemptIncStrong(objectId)) {
        refs_->SetAttemptAcquire();
        return true;
    }
    return false;
}

bool RefBase::IsAttemptAcquireSet()
{
    if (refs_ == nullptr) {
        return false;
    }
    return refs_->IsAttemptAcquireSet();
}

bool RefBase::IsExtendLifeTimeSet()
{
    if (refs_ == nullptr) {
        return false;
    }
    return refs_->IsLifeTimeExtended();
}

void RefBase::OnFirstStrongRef(const void*)
{}

void RefBase::OnLastStrongRef(const void*)
{}

void RefBase::OnLastWeakRef(const void*)
{}

bool RefBase::OnAttemptPromoted(const void*)
{
    return true;
}

#if ((defined DEBUG_REFBASE) && (!defined TRACK_ALL))
void RefBase::EnableTracker()
{
    refs_->EnableTracker();
}
#else
void RefBase::EnableTracker()
{
}
#endif

void RefBase::EnableTrackerWithDomainId(unsigned int domainId)
{
#if ((defined DEBUG_REFBASE) && (defined PRINT_TRACK_AT_ONCE))
    refs_->EnableTrackerWithDomainId(domainId);
#endif
}

}  // namespace OHOS