xref: /arkcompiler/ets_runtime/ecmascript/dfx/vmstat/runtime_stat.h

/*
 * Copyright (c) 2021-2023 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.
 */

#ifndef ECMASCRIPT_DFX_VMSTAT_RUNTIME_STAT_H
#define ECMASCRIPT_DFX_VMSTAT_RUNTIME_STAT_H

#include "ecmascript/ecma_vm.h"
#include "ecmascript/js_thread.h"
#include "ecmascript/mem/c_containers.h"
#include "ecmascript/dfx/vmstat/caller_stat.h"

namespace panda::ecmascript {
class EcmaRuntimeStat {
public:
    // NOLINTNEXTLINE(modernize-avoid-c-arrays)
    EcmaRuntimeStat(const char * const runtimeCallerNames[], int count);
    EcmaRuntimeStat() = default;
    virtual ~EcmaRuntimeStat() = default;

    DEFAULT_NOEXCEPT_MOVE_SEMANTIC(EcmaRuntimeStat);
    DEFAULT_COPY_SEMANTIC(EcmaRuntimeStat);

    void SetRuntimeStatEnabled(bool enable)
    {
        runtimeStatEnabled_ = enable;
    }
    bool IsRuntimeStatEnabled()
    {
        return runtimeStatEnabled_;
    }
    void PUBLIC_API StartCount(PandaRuntimeTimer *timer, int callerId);
    void PUBLIC_API StopCount(const PandaRuntimeTimer *timer);
    void PrintAllStats() const;
    void ResetAllCount();
    void Print() const;

private:
    bool runtimeStatEnabled_ {false};
    PandaRuntimeTimer *currentTimer_ = nullptr;
    CVector<PandaRuntimeCallerStat> callerStat_ {};
};

class EcmaRuntimeStatScope {
public:
    explicit EcmaRuntimeStatScope(EcmaVM *vm);
    virtual ~EcmaRuntimeStatScope();

private:
    EcmaVM *vm_ = nullptr;
};

class RuntimeTimerScope {
public:
    RuntimeTimerScope(int callerId, EcmaRuntimeStat *stat)
    {
        if (stat == nullptr || !stat->IsRuntimeStatEnabled()) {
            return;
        }
        stats_ = stat;
        stats_->StartCount(&timer_, callerId);
    }
    ~RuntimeTimerScope()
    {
        if (stats_ != nullptr) {
            stats_->StopCount(&timer_);
        }
    }
    NO_COPY_SEMANTIC(RuntimeTimerScope);
    NO_MOVE_SEMANTIC(RuntimeTimerScope);

private:
    PandaRuntimeTimer timer_ {};
    EcmaRuntimeStat *stats_ {nullptr};
};
}  // namespace panda::ecmascript
#endif // ECMASCRIPT_DFX_VMSTAT_RUNTIME_STAT_H