los_perf.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2017-2020. All rights reserved.
 * Description: LiteOS Performance Monitor Module Implementation
 * Author: Huawei LiteOS Team
 * Create: 2017-01-01
 * 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.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_PERF_H
#define _LOS_PERF_H
 
#include "los_typedef.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define PERF_MAX_FILTER_TSKS                32
 
#define PERF_MAX_EVENT                      7
 
#define PERF_MAX_CALLCHAIN_DEPTH            10
 
#define PERF_BUFFER_WATERMARK_ONE_N         2
 
enum PerfStatus {
    PERF_UNINIT,   
    PERF_STARTING,  
    PERF_STARTED,  
    PERF_STOPPING, 
    PERF_STOPED,   
};
 
typedef VOID (*PERF_BUF_NOTIFY_HOOK)(VOID);
 
typedef VOID (*PERF_BUF_FLUSH_HOOK)(VOID *addr, UINT32 size);
 
#define LOS_ERRNO_PERF_STATUS_INVALID        LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x00)
 
#define LOS_ERRNO_PERF_HW_INIT_ERROR         LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x01)
 
#define LOS_ERRNO_PERF_TIMED_INIT_ERROR      LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x02)
 
#define LOS_ERRNO_PERF_SW_INIT_ERROR         LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x03)
 
#define LOS_ERRNO_PERF_BUF_ERROR             LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x04)
 
#define LOS_ERRNO_PERF_INVALID_PMU           LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x05)
 
#define LOS_ERRNO_PERF_PMU_CONFIG_ERROR      LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x06)
 
#define LOS_ERRNO_PERF_CONFIG_NULL      LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x07)
 
#define LOS_ERRNO_PERF_CONFIG_TASK_FILTER_ERROR      LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x08)
 
#define LOS_ERRNO_PERF_INIT_NO_MEMERY               LOS_ERRNO_OS_ERROR(LOS_MOD_PERF, 0x09)
 
enum PerfEventType {
    PERF_EVENT_TYPE_HW,      
    PERF_EVENT_TYPE_TIMED,   
    PERF_EVENT_TYPE_SW,      
    PERF_EVENT_TYPE_RAW,     
    PERF_EVENT_TYPE_MAX
};
 
enum PmuHwId {
    PERF_COUNT_HW_CPU_CYCLES = 0,      
    PERF_COUNT_HW_INSTRUCTIONS,        
    PERF_COUNT_HW_DCACHE_REFERENCES,   
    PERF_COUNT_HW_DCACHE_MISSES,       
    PERF_COUNT_HW_ICACHE_REFERENCES,   
    PERF_COUNT_HW_ICACHE_MISSES,       
    PERF_COUNT_HW_BRANCH_INSTRUCTIONS, 
    PERF_COUNT_HW_BRANCH_MISSES,       
    PERF_COUNT_HW_MAX,
};
 
enum PmuTimedId {
    PERF_COUNT_CPU_CLOCK = 0,      
};
 
enum PmuSwId {
    PERF_COUNT_SW_TASK_SWITCH = 1, 
    PERF_COUNT_SW_IRQ_RESPONSE,    
    PERF_COUNT_SW_MEM_ALLOC,       
    PERF_COUNT_SW_MUX_PEND,        
    PERF_COUNT_SW_MAX,
};
 
enum PerfSampleType {
    PERF_RECORD_CPU       = 1U << 0, 
    PERF_RECORD_TID       = 1U << 1, 
    PERF_RECORD_TYPE      = 1U << 2, 
    PERF_RECORD_PERIOD    = 1U << 3, 
    PERF_RECORD_TIMESTAMP = 1U << 4, 
    PERF_RECORD_IP        = 1U << 5, 
    PERF_RECORD_CALLCHAIN = 1U << 6, 
};
 
typedef struct {
    UINT32 type;              
    struct {
        UINT32 eventId;       
        UINT32 period;        
    } events[PERF_MAX_EVENT]; 
    UINT32 eventsNr;          
    BOOL predivided;          
} PerfEventConfig;
 
typedef struct {
    PerfEventConfig         eventsCfg;                      
    UINT32                  taskIds[PERF_MAX_FILTER_TSKS];  
    UINT32                  taskIdsNr;                      
    UINT32                  sampleType;                     
    BOOL                    needSample;                     
    BOOL                    taskFilterEnable;               
} PerfConfigAttr;
 
extern VOID OsPerfHook(UINT32 event);
 
#if defined(LOSCFG_KERNEL_PERF) && defined(LOSCFG_PERF_SW_PMU)
#define LOS_PERF(EVENT) do {      \
        OsPerfHook(EVENT);        \
    } while (0)
#else
#define LOS_PERF(EVENT)
#endif
 
UINT32 LOS_PerfInit(VOID *buf, UINT32 size);
 
VOID LOS_PerfStart(UINT32 sectionId);
 
VOID LOS_PerfStop(VOID);
 
UINT32 LOS_PerfConfig(PerfConfigAttr *attr);
 
UINT32 LOS_PerfDataRead(CHAR *dest, UINT32 size);
 
VOID LOS_PerfNotifyHookReg(const PERF_BUF_NOTIFY_HOOK func);
 
VOID LOS_PerfFlushHookReg(const PERF_BUF_FLUSH_HOOK func);
 
UINT32 LOS_PerfDeinit(VOID);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_PERF_H */