app_perf_stats.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2019 Texas Instruments Incorporated
 *
 * All rights reserved not granted herein.
 *
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
 * license under copyrights and patents it now or hereafter owns or controls to make,
 * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
 * terms herein.  With respect to the foregoing patent license, such license is granted
 * solely to the extent that any such patent is necessary to Utilize the software alone.
 * The patent license shall not apply to any combinations which include this software,
 * other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license
 * (including the above copyright notice and the disclaimer and (if applicable) source
 * code license limitations below) in the documentation and/or other materials provided
 * with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided
 * that the following conditions are met:
 *
 * *       No reverse engineering, decompilation, or disassembly of this software is
 * permitted with respect to any software provided in binary form.
 *
 * *       any redistribution and use are licensed by TI for use only with TI Devices.
 *
 * *       Nothing shall obligate TI to provide you with source code for the software
 * licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the
 * source code are permitted provided that the following conditions are met:
 *
 * *       any redistribution and use of the source code, including any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * *       any redistribution and use of any object code compiled from the source code
 * and any resulting derivative works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
 *
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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 __APP_PERF_STATS_H__
#define __APP_PERF_STATS_H__

#include <stdint.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

#include <utils/mem/include/app_mem.h>

typedef enum {

    APP_PERF_HWA_VPAC1_VISS,
    APP_PERF_HWA_VPAC1_LDC,
    APP_PERF_HWA_VPAC1_NF,
    APP_PERF_HWA_VPAC1_MSC0,
    APP_PERF_HWA_VPAC1_MSC1,
    APP_PERF_HWA_DOF,
    APP_PERF_HWA_SDE,
    APP_PERF_HWA_GPU,
    #if defined(SOC_J784S4) || defined(SOC_J742S2)
    APP_PERF_HWA_VPAC2_VISS,
    APP_PERF_HWA_VPAC2_LDC,
    APP_PERF_HWA_VPAC2_NF,
    APP_PERF_HWA_VPAC2_MSC0,
    APP_PERF_HWA_VPAC2_MSC1,
    #endif
    APP_PERF_HWA_MAX

} app_perf_hwa_id_t;


#define APP_PERF_STATS_TASK_NAME_MAX (12u)

#define APP_PERF_STATS_TASK_MAX (24u)

#define APP_PERF_POINT_NAME_MAX     (16u)

#define APP_PERF_POINT_MAX_FILENAME     (256u)

#define APP_PERF_MAX_LINE_SIZE     (1024u)

typedef struct {

    uint32_t cpu_load; 
    uint32_t hwi_load; 
    uint32_t swi_load; 
} app_perf_stats_cpu_load_t;


typedef struct {

    char     name[APP_PERF_POINT_NAME_MAX];
    uint64_t tmp;
    uint64_t sum;
    uint64_t avg;
    uint64_t min;
    uint64_t max;
    uint64_t num;

} app_perf_point_t;

typedef struct {

    char task_name[APP_PERF_STATS_TASK_NAME_MAX]; 
    uint32_t task_load; 
} app_perf_stats_cpu_task_stats_t;

typedef struct {

    uint32_t num_tasks;     
    uint32_t starting_task; 
    app_perf_stats_cpu_task_stats_t task_stats[APP_PERF_STATS_TASK_MAX]; 
} app_perf_stats_task_stats_t;

typedef struct {

    uint32_t num_tasks; 
    app_mem_stats_t mem_stats[APP_MEM_HEAP_MAX]; 
} app_perf_stats_mem_stats_t;

typedef struct {

    uint64_t total_time; 
    uint64_t active_time; 
    uint64_t pixels_processed; 
    uint64_t last_timestamp; 
} app_perf_stats_hwa_load_t;

typedef struct {

    app_perf_stats_hwa_load_t hwa_stats[APP_PERF_HWA_MAX]; 
} app_perf_stats_hwa_stats_t;


typedef struct {

    uint32_t read_bw_avg;   
    uint32_t write_bw_avg;  
    uint32_t read_bw_peak;  
    uint32_t write_bw_peak; 
    uint32_t total_available_bw; 
    uint32_t counter0_total;  
    uint32_t counter1_total;  
    uint32_t counter2_total;  
    uint32_t counter3_total;  
} app_perf_stats_ddr_stats_t;

typedef struct {

    uint32_t semaphore_count;  
    uint32_t mutex_count;      
    uint32_t queue_count;      
    uint32_t event_count;      
    uint32_t heap_count;       
    uint32_t mailbox_count;    
    uint32_t task_count;       
    uint32_t clock_count;      
    uint32_t hwi_count;        
    uint32_t timer_count;      
    uint32_t semaphore_peak;   
    uint32_t mutex_peak;       
    uint32_t queue_peak;       
    uint32_t event_peak;       
    uint32_t heap_peak;        
    uint32_t mailbox_peak;     
    uint32_t task_peak;        
    uint32_t clock_peak;       
    uint32_t hwi_peak;         
    uint32_t timer_peak;       
} app_perf_stats_os_stats_t;

typedef struct {

    uint32_t targets_in_cpu;
    uint32_t max_targets_per_kernel;
    uint32_t target_kernel_instance_max;
    uint32_t target_kernel_max;

} app_perf_stats_tiovx_stats_t;

typedef void (*tiovxStats_Fxn) (app_perf_stats_tiovx_stats_t* tiovx_stats);

typedef struct {
    tiovxStats_Fxn get_tiovx_stats;
} app_perf_registration_t;

int32_t appPerfStatsInit();

int32_t appPerfStatsInitRegister(app_perf_registration_t * reg_fxns);

int32_t appPerfStatsRemoteServiceInit();

int32_t appPerfStatsCpuLoadReset(uint32_t app_cpu_id);

int32_t appPerfStatsCpuLoadGet(uint32_t app_cpu_id, app_perf_stats_cpu_load_t *cpu_load);

int32_t appPerfStatsCpuTaskStatsGet(uint32_t app_cpu_id, app_perf_stats_task_stats_t *cpu_stats);

int32_t appPerfStatsCpuTaskStatsPrint(uint32_t app_cpu_id, app_perf_stats_task_stats_t *cpu_stats);

int32_t appPerfStatsCpuTaskStacksStatsGet(uint32_t app_cpu_id, app_perf_stats_task_stats_t *cpu_stats);

int32_t appPerfStatsCpuTaskStacksStatsPrint(uint32_t app_cpu_id, app_perf_stats_task_stats_t *cpu_stats);

int32_t appPerfStatsCpuMemStatsGet(uint32_t app_cpu_id, app_perf_stats_mem_stats_t *cpu_stats);

int32_t appPerfStatsCpuMemStatsPrint(uint32_t app_cpu_id, app_perf_stats_mem_stats_t *cpu_stats);

int32_t appPerfStatsCpuLoadPrint(uint32_t app_cpu_id, app_perf_stats_cpu_load_t *cpu_load);

int32_t appPerfStatsCpuLoadPrintAll();

int32_t appPerfStatsCpuOsStatsGet(uint32_t app_cpu_id, app_perf_stats_os_stats_t *os_stats);

int32_t appPerfStatsCpuTiovxStatsGet(uint32_t app_cpu_id, app_perf_stats_tiovx_stats_t *tiovx_stats);

int32_t appPerfStatsCpuOsStatsPrint(uint32_t app_cpu_id, app_perf_stats_os_stats_t *os_stats, uint32_t showPeak);

int32_t appPerfStatsCpuTiovxStatsPrint(uint32_t app_cpu_id, app_perf_stats_tiovx_stats_t *tiovx_stats);

int32_t appPerfStatsCpuStatsPrintAll();


int32_t appPerfStatsCpuLoadResetAll();


int32_t appPerfStatsPrintAll();

int32_t appPerfStatsRegisterTask(void *task_handle, const char *name);

int32_t appPerfStatsDeInit();


void appPerfPointSetName(app_perf_point_t *prm, const char *name);

void appPerfPointReset(app_perf_point_t *prm);

void appPerfPointBegin(app_perf_point_t *prm);


void appPerfPointEnd(app_perf_point_t *prm);


void appPerfPointPrint(app_perf_point_t *prm);


void appPerfPointPrintFPS(app_perf_point_t *prm);

FILE *appPerfStatsExportOpenFile(const char *output_file_path, const char *output_file_prefix);

int32_t appPerfStatsExportAll(FILE *fp, app_perf_point_t *perf_points[], uint32_t num_points);

int32_t appPerfStatsExportCloseFile(FILE *fp);

void appPerfStatsHwaUpdateLoad(app_perf_hwa_id_t id, uint32_t active_time_in_usecs, uint32_t pixels_processed);

int32_t appPerfStatsHwaStatsGet(uint32_t app_cpu_id, app_perf_stats_hwa_stats_t *hwa_stats);

int32_t appPerfStatsHwaLoadPrint(app_perf_stats_hwa_stats_t *hwa_load);

int32_t appPerfStatsHwaLoadPrintAll();

int32_t appPerfStatsHwaLoadResetAll();


char *appPerfStatsGetHwaName(app_perf_hwa_id_t hwa_id);


int32_t appPerfStatsDdrStatsGet(app_perf_stats_ddr_stats_t *ddr_stats);

int32_t appPerfStatsDdrStatsPrint(app_perf_stats_ddr_stats_t *ddr_load);

int32_t appPerfStatsDdrStatsPrintAll();

int32_t appPerfStatsDdrStatsResetAll();

void appPerfStatsResetAll();

/* @} */

#ifdef __cplusplus
}
#endif

#endif