xref: /foundation/resourceschedule/ffrt/src/eu/cpu_monitor.h

/*
 * Copyright (c) 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 CPU_MONITOR_H
#define CPU_MONITOR_H

#include <atomic>
#include <vector>
#include <functional>
#include <mutex>
#include "qos.h"
#include "cpp/mutex.h"
#include "eu/cpu_manager_interface.h"
#include "c/type_def_ext.h"
#include "util/token.h"
#include "internal_inc/config.h"
#ifdef FFRT_WORKERS_DYNAMIC_SCALING
#include "eu/blockaware.h"
#endif

namespace ffrt {

struct WorkerCtrl {
    size_t hardLimit = 0;
    size_t maxConcurrency = 0;
    size_t reserveNum = 0;
    int executionNum = 0;
    int sleepingWorkerNum = 0;
    bool pollWaitFlag = false;
    int deepSleepingWorkerNum = 0;
    bool hasWorkDeepSleep = false;
    bool retryBeforeDeepSleep = true;
    std::mutex lock;
};

class CPUMonitor {
public:
    CPUMonitor(CpuMonitorOps&& ops);
    CPUMonitor(const CPUMonitor&) = delete;
    CPUMonitor& operator=(const CPUMonitor&) = delete;
    virtual ~CPUMonitor();
    uint32_t GetMonitorTid() const;
    virtual SleepType IntoSleep(const QoS& qos) = 0;
    virtual void WakeupCount(const QoS& qos, bool isDeepSleepWork = false);
    void IntoDeepSleep(const QoS& qos);
    void OutOfDeepSleep(const QoS& qos);
    void TimeoutCount(const QoS& qos);
    bool IsExceedDeepSleepThreshold();
    void IntoPollWait(const QoS& qos);
    void OutOfPollWait(const QoS& qos);
    void DoDestroy(const QoS& qos);
#ifdef FFRT_WORKERS_DYNAMIC_SCALING
    bool IsExceedRunningThreshold(const QoS& qos);
    bool IsBlockAwareInit(void);
    void MonitorMain();
    BlockawareWakeupCond* WakeupCond(void);
#endif
    virtual void Notify(const QoS& qos, TaskNotifyType notifyType) = 0;
    virtual void WorkerInit() = 0;
    int QosWorkerNumSegment (ffrt_worker_num_param* qosData);
    bool TryAcquirePublicWorkerNum(const QoS& qos);
    /* strategy options for handling task notify events */
    static void HandleTaskNotifyDefault(const QoS& qos, void* p, TaskNotifyType notifyType);
    int WakedWorkerNum(const QoS& qos);
    int SleepingWorkerNum(const QoS& qos);
    void NotifyWorkers(const QoS& qos, int number);
    bool HasDeepSleepWork(const QoS& qos);
    uint32_t monitorTid = 0;
protected:
    WorkerCtrl ctrlQueue[QoS::MaxNum()];
    void PokeAdd(const QoS& qos);
    void PokePick(const QoS& qos);
    void Poke(const QoS& qos, uint32_t taskCount, TaskNotifyType notifyType);
    CpuMonitorOps& GetOps()
    {
        return ops;
    }
private:
    void SetupMonitor();
    void StartMonitor();

    std::thread* monitorThread;
    CpuMonitorOps ops;
    bool setWorkerNum = false;
    std::mutex setWorkerNumLock;
    void SetWorkerPara(unsigned int& param, unsigned int value);
    int SetQosWorkerPara(ffrt_qos_config& qosCfg);
    bool QosWorkerNumValid(ffrt_worker_num_param* qosData);
    bool LowQosUseReserveWorkerNum();
    bool HighQosUseReserveWorkerNum();
    void ReleasePublicWorkerNum(const QoS& qos);
    void LogAllWorkerNum();
    unsigned int globalReserveWorkerNum = 0;
    unsigned int lowQosReserveWorkerNum = 0;
    unsigned int highQosReserveWorkerNum = 0;
    std::unique_ptr<Token> globalReserveWorkerToken = nullptr;
    std::unique_ptr<Token> lowQosReserveWorkerToken = nullptr;
    std::unique_ptr<Token> highQosReserveWorkerToken = nullptr;
    std::unique_ptr<Token> lowQosUseGlobalWorkerToken = nullptr;
    std::unique_ptr<Token> highQosUseGlobalWorkerToken = nullptr;
    QosWorkerConfig qosWorkerConfig;
#ifdef FFRT_WORKERS_DYNAMIC_SCALING
    bool blockAwareInit = false;
    bool stopMonitor = false;
    unsigned long keyPtr = 0;
    int qosMonitorMaxNum = std::min(QoS::Max(), BLOCKAWARE_DOMAIN_ID_MAX + 1);
    BlockawareWakeupCond wakeupCond;
    BlockawareDomainInfoArea domainInfoMonitor;
    BlockawareDomainInfoArea domainInfoNotify;
    std::atomic<bool> exceedUpperWaterLine[QoS::MaxNum()];
#endif
};
}
#endif /* CPU_MONITOR_H */