/*
* Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
* Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @defgroup los_cpup CPU usage
* @ingroup kernel
*/
#ifndef _LOS_CPUP_H
#define _LOS_CPUP_H
#include "los_hwi.h"
#include "los_base.h"
#include "los_sys.h"
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
/**
* @ingroup los_cpup
* CPU usage error code: The request for memory fails.
*
* Value: 0x02001e00
*
* Solution: Decrease the maximum number of processes.
*/
#define LOS_ERRNO_CPUP_NO_MEMORY LOS_ERRNO_OS_ERROR(LOS_MOD_CPUP, 0x00)
/**
* @ingroup los_cpup
* CPU usage error code: The pointer to an input parameter is error.
*
* Value: 0x02001e01
*
* Solution: Check whether input parameter is valid.
*/
#define LOS_ERRNO_CPUP_PTR_ERR LOS_ERRNO_OS_ERROR(LOS_MOD_CPUP, 0x01)
/**
* @ingroup los_cpup
* CPU usage error code: The CPU usage is not initialized.
*
* Value: 0x02001e02
*
* Solution: Check whether the CPU usage is initialized.
*/
#define LOS_ERRNO_CPUP_NO_INIT LOS_ERRNO_OS_ERROR(LOS_MOD_CPUP, 0x02)
/**
* @ingroup los_cpup
* CPU usage error code: The target cpup is not created.
*
* Value: 0x02001e03
*
* Solution: Check whether the target cpup is created.
*/
#define LOS_ERRNO_CPUP_NO_CREATED LOS_ERRNO_OS_ERROR(LOS_MOD_CPUP, 0x03)
/**
* @ingroup los_cpup
* CPU usage error code: The target cpup ID is invalid.
*
* Value: 0x02001e04
*
* Solution: Check whether the target cpup ID is applicable for the current operation.
*/
#define LOS_ERRNO_CPUP_ID_INVALID LOS_ERRNO_OS_ERROR(LOS_MOD_CPUP, 0x04)
/**
* @ingroup los_cpup
* Sum of single core cpup with all processes and tasks. It means the value of cpup is a permillage.
*/
#define LOS_CPUP_SINGLE_CORE_PRECISION 10000
/**
* @ingroup los_cpup
* Multiple of current cpup precision change to percent.
*/
#define LOS_CPUP_PRECISION_MULT (LOS_CPUP_SINGLE_CORE_PRECISION / 100)
/**
* @ingroup los_cpup
* Sum of all core cpup with all processes. It means the value of cpup is a permillage.
*/
#define LOS_CPUP_PRECISION (LOS_CPUP_SINGLE_CORE_PRECISION * LOSCFG_KERNEL_CORE_NUM)
/**
* @ingroup los_cpup
* Count the CPU usage structures of all cpup.
*/
typedef struct tagCpupInfo {
UINT16 status; /**< Save the cur cpup status */
UINT32 usage; /**< Usage. The value range is [0, LOS_CPUP_SINGLE_CORE_PRECISION]. */
} CPUP_INFO_S;
/**
* @ingroup los_cpup
* Query the CPU usage of the system.
*/
enum {
CPUP_LAST_TEN_SECONDS = 0, /**< Display CPU usage in the last ten seconds. */
CPUP_LAST_ONE_SECONDS = 1, /**< Display CPU usage in the last one seconds. */
CPUP_ALL_TIME = 0xffff /**< Display CPU usage from system startup to now. */
};
/**
* @ingroup los_cpup
* @brief Obtain the historical CPU usage.
*
* @par Description:
* This API is used to obtain the historical CPU usage.
* @attention
*
* - This API can be called only after the CPU usage is initialized. Otherwise, the CPU usage fails to be
* obtained.
*
*
* @param mode [IN] UINT16. process mode. The parameter value 0 indicates that the CPU usage within 10s will be
* obtained, and the parameter value 1 indicates that the CPU usage in the former 1s will
* be obtained. Other values indicate that the CPU usage in all time will be obtained.
*
* @retval #LOS_ERRNO_CPUP_NO_INIT The CPU usage is not initialized.
* @retval #UINT32 [0, LOS_CPUP_SINGLE_CORE_PRECISION], historical CPU usage,
* of which the precision is adjustable.
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern UINT32 LOS_HistorySysCpuUsage(UINT16 mode);
/**
* @ingroup los_cpup
* @brief Obtain the historical CPU usage of a specified process.
*
* @par Description:
* This API is used to obtain the historical CPU usage of a process specified by a passed-in process ID.
* @attention
*
* - This API can be called only after the CPU usage is initialized. Otherwise,
* the CPU usage fails to be obtained.
* - The passed-in process ID must be valid and the process specified by the process ID must be created. Otherwise,
* the CPU usage fails to be obtained.
*
*
* @param pid [IN] UINT32. process ID.
* @param mode [IN] UINT16. cpup mode. The parameter value 0 indicates that the CPU usage within 10s will be
* obtained, and the parameter value 1 indicates that the CPU usage in the former 1s will
* be obtained. Other values indicate that the CPU usage in the period that is less than
* 1s will be obtained.
*
* @retval #LOS_ERRNO_CPUP_NO_INIT The CPU usage is not initialized.
* @retval #LOS_ERRNO_CPUP_ID_INVALID The target process ID is invalid.
* @retval #LOS_ERRNO_CPUP_NO_CREATED The target process is not created.
* @retval #UINT32 [0, LOS_CPUP_PRECISION], CPU usage of the specified process.
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern UINT32 LOS_HistoryProcessCpuUsage(UINT32 pid, UINT16 mode);
/**
* @ingroup los_cpup
* @brief Obtain the historical CPU usage of a specified task.
*
* @par Description:
* This API is used to obtain the historical CPU usage of a task specified by a passed-in task ID.
* @attention
*
* - This API can be called only after the CPU usage is initialized. Otherwise,
* the CPU usage fails to be obtained.
* - The passed-in task ID must be valid and the task specified by the task ID must be created. Otherwise,
* the CPU usage fails to be obtained.
*
*
* @param tid [IN] UINT32. task ID.
* @param mode [IN] UINT16. cpup mode. The parameter value 0 indicates that the CPU usage within 10s will be
* obtained, and the parameter value 1 indicates that the CPU usage in the former 1s will
* be obtained. Other values indicate that the CPU usage in the period that is less than
* 1s will be obtained.
*
* @retval #LOS_ERRNO_CPUP_NO_INIT The CPU usage is not initialized.
* @retval #LOS_ERRNO_CPUP_ID_INVALID The target task ID is invalid.
* @retval #LOS_ERRNO_CPUP_NO_CREATED The target task is not created.
* @retval #UINT32 [0, LOS_CPUP_SINGLE_CORE_PRECISION], CPU usage of the specified process.
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern UINT32 LOS_HistoryTaskCpuUsage(UINT32 tid, UINT16 mode);
/**
* @ingroup los_cpup
* @brief Obtain the CPU usage of processes.
*
* @par Description:
* This API is used to obtain the CPU usage of processes.
* @attention
*
* - This API can be called only after the CPU usage is initialized. Otherwise, the CPU usage fails to be
* obtained.
* - The input parameter pointer must not be NULL, Otherwise, the CPU usage fails to be obtained.
* - The input parameter pointer should point to the structure array whose size be greater than
* (LOS_GetSystemProcessMaximum() * sizeof (CPUP_INFO_S)).
*
*
* @param mode [IN] UINT16. Time mode. The parameter value 0 indicates that the CPU usage within 10s will be
* obtained, and the parameter value 1 indicates that the CPU usage in the former 1s
* will be obtained.Other values indicate that the CPU usage in all time will be
* obtained.
* @param cpupInfo [OUT]Type. CPUP_INFO_S* Pointer to the CPUP information structure to be obtained.
* @param len [IN] UINT32. The Maximum length of processes.
*
* @retval #LOS_ERRNO_CPUP_NO_INIT The CPU usage is not initialized.
* @retval #LOS_ERRNO_CPUP_PROCESS_PTR_ERR The input parameter pointer is NULL or
* len less than LOS_GetSystemProcessMaximum() * sizeof (CPUP_INFO_S).
* @retval #LOS_OK The CPU usage of all processes is successfully obtained.
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern UINT32 LOS_GetAllProcessCpuUsage(UINT16 mode, CPUP_INFO_S *cpupInfo, UINT32 len);
#ifdef LOSCFG_CPUP_INCLUDE_IRQ
/**
* @ingroup los_cpup
* @brief Obtain the CPU usage of hwi.
*
* @par Description:
* This API is used to obtain the CPU usage of hwi.
* @attention
*
* - This API can be called only after the CPU usage is initialized. Otherwise, the CPU usage fails to be
* obtained.
* - The input parameter pointer must not be NULL, Otherwise, the CPU usage fails to be obtained.
* - The input parameter pointer should point to the structure array whose size be greater than
* (LOS_GetSystemHwiMaximum() * sizeof (CPUP_INFO_S)).
*
*
* @param mode [IN] UINT16. Time mode. The parameter value 0 indicates that the CPU usage within 10s will be
* obtained, and the parameter value 1 indicates that the CPU usage in the former 1s
* will be obtained.Other values indicate that the CPU usage in all time will be
* obtained.
* @param cpupInfo [OUT]Type. CPUP_INFO_S* Pointer to the CPUP information structure to be obtained.
* @param len [IN] UINT32. The Maximum length of hwis.
*
* @retval #LOS_ERRNO_CPUP_NO_INIT The CPU usage is not initialized.
* @retval #LOS_ERRNO_CPUP_PROCESS_PTR_ERR The input parameter pointer is NULL or
* len less than LOS_GetSystemHwiMaximum() * sizeof (CPUP_INFO_S).
* @retval #LOS_OK The CPU usage of all hwis is successfully obtained.
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern UINT32 LOS_GetAllIrqCpuUsage(UINT16 mode, CPUP_INFO_S *cpupInfo, UINT32 len);
#endif
/**
* @ingroup los_cpup
* @brief Reset the data of CPU usage.
*
* @par Description:
* This API is used to reset the data of CPU usage.
* @attention
*
*
* @param None.
*
* @retval #None.
*
* @par Dependency:
* - los_cpup.h: the header file that contains the API declaration.
* @see
*/
extern VOID LOS_CpupReset(VOID);
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
#endif