CPU usage

CPU usage 的协作图:

结构体
struct	OsIrqCpupCB
struct	tagCpupInfo

类型定义
typedef struct tagCpupInfo	CPUP_INFO_S

枚举
enum	{ CPUP_LAST_TEN_SECONDS = 0 , CPUP_LAST_ONE_SECONDS = 1 , CPUP_ALL_TIME = 0xffff }

函数
UINT32	LOS_HistorySysCpuUsage (UINT16 mode)
	Obtain the historical CPU usage. 更多...
UINT32	LOS_HistoryProcessCpuUsage (UINT32 pid, UINT16 mode)
	Obtain the historical CPU usage of a specified process. 更多...
UINT32	LOS_HistoryTaskCpuUsage (UINT32 tid, UINT16 mode)
	Obtain the historical CPU usage of a specified task. 更多...
UINT32	LOS_GetAllProcessCpuUsage (UINT16 mode, CPUP_INFO_S *cpupInfo, UINT32 len)
	Obtain the CPU usage of processes. 更多...
UINT32	LOS_GetAllIrqCpuUsage (UINT16 mode, CPUP_INFO_S *cpupInfo, UINT32 len)
	Obtain the CPU usage of hwi. 更多...
VOID	LOS_CpupReset (VOID)
	Reset the data of CPU usage. 更多...

详细描述

类型定义说明

CPUP_INFO_S

typedef struct tagCpupInfo CPUP_INFO_S

Count the CPU usage structures of all cpup.

枚举类型说明

anonymous enum

anonymous enum

Query the CPU usage of the system.

枚举值
CPUP_LAST_TEN_SECONDS	Display CPU usage in the last ten seconds.
CPUP_LAST_ONE_SECONDS	Display CPU usage in the last one seconds.
CPUP_ALL_TIME	Display CPU usage from system startup to now.

在文件 los_cpup.h 第 131 行定义.

     {
    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. */
};

函数说明

LOS_CpupReset()

VOID LOS_CpupReset

(

VOID

)

Reset the data of CPU usage.

Description:

This API is used to reset the data of CPU usage.

注意

• None.

参数

None.

返回值

#None.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

在文件 los_cpup.c 第 281 行定义.

{
    LosProcessCB *processCB = NULL;
    LosTaskCB *taskCB = NULL;
    UINT32 index;
    UINT64 cycle;
    UINT32 intSave;
 
    cpupInitFlg = 0;
    intSave = LOS_IntLock();
    (VOID)LOS_SwtmrStop(cpupSwtmrID);
    cycle = OsGetCpuCycle();
 
    for (index = 0; index < (OS_CPUP_HISTORY_RECORD_NUM + 1); index++) {
        cpuHistoryTime[index] = cycle;
    }
 
    for (index = 0; index < g_processMaxNum; index++) {
        processCB = OS_PCB_FROM_PID(index);
        if (processCB->processCpup == NULL) {
            continue;
        }
        OsResetCpup(processCB->processCpup, cycle);
    }
 
    for (index = 0; index < g_taskMaxNum; index++) {
        taskCB = OS_TCB_FROM_TID(index);
        OsResetCpup(&taskCB->taskCpup, cycle);
    }
 
#ifdef LOSCFG_CPUP_INCLUDE_IRQ
    if (g_irqCpup != NULL) {
        for (index = 0; index < cpupMaxNum; index++) {
            OsResetCpup(&g_irqCpup[index].cpup, cycle);
            g_irqCpup[index].timeMax = 0;
        }
 
        for (index = 0; index < LOSCFG_KERNEL_CORE_NUM; index++) {
            timeInIrqSwitch[index] = 0;
        }
    }
#endif
 
    (VOID)LOS_SwtmrStart(cpupSwtmrID);
    LOS_IntRestore(intSave);
    cpupInitFlg = 1;
 
    return;
}

函数调用图:

LOS_GetAllIrqCpuUsage()

UINT32 LOS_GetAllIrqCpuUsage	(	UINT16	mode,
		CPUP_INFO_S *	cpupInfo,
		UINT32	len
	)

Obtain the CPU usage of hwi.

Description:

This API is used to obtain the CPU usage of hwi.

注意

• 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)).

参数

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.
cpupInfo	[OUT]Type. CPUP_INFO_S* Pointer to the CPUP information structure to be obtained.
len	[IN] UINT32. The Maximum length of hwis.

返回值

#LOS_ERRNO_CPUP_NO_INIT	The CPU usage is not initialized.
#LOS_ERRNO_CPUP_PROCESS_PTR_ERR	The input parameter pointer is NULL or len less than LOS_GetSystemHwiMaximum() * sizeof (CPUP_INFO_S).
#LOS_OK	The CPU usage of all hwis is successfully obtained.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

Obtain the CPU usage of hwi.

参数

mode
cpupInfo
len

返回

在文件 los_cpup.c 第 715 行定义.

{
    UINT32 intSave;
    UINT32 ret;
 
    SCHEDULER_LOCK(intSave);
    ret = OsGetAllIrqCpuUsageUnsafe(mode, cpupInfo, len);
    SCHEDULER_UNLOCK(intSave);
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

LOS_GetAllProcessCpuUsage()

UINT32 LOS_GetAllProcessCpuUsage	(	UINT16	mode,
		CPUP_INFO_S *	cpupInfo,
		UINT32	len
	)

Obtain the CPU usage of processes.

Description:

This API is used to obtain the CPU usage of processes.

注意

• 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)).

参数

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.
cpupInfo	[OUT]Type. CPUP_INFO_S* Pointer to the CPUP information structure to be obtained.
len	[IN] UINT32. The Maximum length of processes.

返回值

#LOS_ERRNO_CPUP_NO_INIT	The CPU usage is not initialized.
#LOS_ERRNO_CPUP_PROCESS_PTR_ERR	The input parameter pointer is NULL or len less than LOS_GetSystemProcessMaximum() * sizeof (CPUP_INFO_S).
#LOS_OK	The CPU usage of all processes is successfully obtained.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

Obtain the CPU usage of processes.

在文件 los_cpup.c 第 584 行定义.

{
    UINT32 intSave;
    UINT32 ret;
 
    SCHEDULER_LOCK(intSave);
    ret = OsGetAllProcessCpuUsageUnsafe(mode, cpupInfo, len);
    SCHEDULER_UNLOCK(intSave);
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

LOS_HistoryProcessCpuUsage()

UINT32 LOS_HistoryProcessCpuUsage	(	UINT32	pid,
		UINT16	mode
	)

Obtain the historical CPU usage of a specified process.

Description:

This API is used to obtain the historical CPU usage of a process specified by a passed-in process ID.

注意

• 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.

参数

pid	[IN] UINT32. process ID.
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.

返回值

#LOS_ERRNO_CPUP_NO_INIT	The CPU usage is not initialized.
#LOS_ERRNO_CPUP_ID_INVALID	The target process ID is invalid.
#LOS_ERRNO_CPUP_NO_CREATED	The target process is not created.
UINT32	[0, LOS_CPUP_PRECISION], CPU usage of the specified process.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

Obtain the historical CPU usage of a specified process.

参数

pid
mode

返回

在文件 los_cpup.c 第 485 行定义.

{
    UINT32 cpup;
    UINT32 intSave;
 
    SCHEDULER_LOCK(intSave);
    cpup = OsHistoryProcessCpuUsageUnsafe(pid, mode);
    SCHEDULER_UNLOCK(intSave);
    return cpup;
}

函数调用图:

这是这个函数的调用关系图:

LOS_HistorySysCpuUsage()

UINT32 LOS_HistorySysCpuUsage

(

UINT16

mode

)

Obtain the historical CPU usage.

Description:

This API is used to obtain the historical CPU usage.

注意

• This API can be called only after the CPU usage is initialized. Otherwise, the CPU usage fails to be obtained.

参数

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.

返回值

#LOS_ERRNO_CPUP_NO_INIT	The CPU usage is not initialized.
UINT32	[0, LOS_CPUP_SINGLE_CORE_PRECISION], historical CPU usage, of which the precision is adjustable.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

Obtain the historical CPU usage.

参数

mode

返回

在文件 los_cpup.c 第 435 行定义.

{
    UINT32 cpup;
    UINT32 intSave;
 
    /* get end time of current process */
    SCHEDULER_LOCK(intSave);
    cpup = OsHistorySysCpuUsageUnsafe(mode);
    SCHEDULER_UNLOCK(intSave);
    return cpup;
}

函数调用图:

这是这个函数的调用关系图:

LOS_HistoryTaskCpuUsage()

UINT32 LOS_HistoryTaskCpuUsage	(	UINT32	tid,
		UINT16	mode
	)

Obtain the historical CPU usage of a specified task.

Description:

This API is used to obtain the historical CPU usage of a task specified by a passed-in task ID.

注意

• 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.

参数

tid	[IN] UINT32. task ID.
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.

返回值

#LOS_ERRNO_CPUP_NO_INIT	The CPU usage is not initialized.
#LOS_ERRNO_CPUP_ID_INVALID	The target task ID is invalid.
#LOS_ERRNO_CPUP_NO_CREATED	The target task is not created.
UINT32	[0, LOS_CPUP_SINGLE_CORE_PRECISION], CPU usage of the specified process.

Dependency:

• los_cpup.h: the header file that contains the API declaration.

参见

Obtain the historical CPU usage of a specified task.

参数

tid
mode

返回

在文件 los_cpup.c 第 530 行定义.

{
    UINT32 intSave;
    UINT32 cpup;
 
    SCHEDULER_LOCK(intSave);
    cpup = OsHistoryTaskCpuUsageUnsafe(tid, mode);
    SCHEDULER_UNLOCK(intSave);
    return cpup;
}

函数调用图: