forked from Archive/PX4-Autopilot
115 lines
3.5 KiB
C
115 lines
3.5 KiB
C
/****************************************************************************
|
|
*
|
|
* Copyright (C) 2012 PX4 Development Team. 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 PX4 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 OWNER 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/**
|
|
* @file perf_counter.h
|
|
* Performance measuring tools.
|
|
*/
|
|
|
|
#ifndef _SYSTEMLIB_PERF_COUNTER_H
|
|
#define _SYSTEMLIB_PERF_COUNTER_H value
|
|
|
|
/**
|
|
* Counter types.
|
|
*/
|
|
enum perf_counter_type {
|
|
PC_COUNT, /**< count the number of times an event occurs */
|
|
PC_ELAPSED /**< measure the time elapsed performing an event */
|
|
};
|
|
|
|
struct perf_ctr_header;
|
|
typedef struct perf_ctr_header *perf_counter_t;
|
|
|
|
__BEGIN_DECLS
|
|
|
|
/**
|
|
* Create a new counter.
|
|
*
|
|
* @param type The type of the new counter.
|
|
* @param name The counter name.
|
|
* @return Handle for the new counter, or NULL if a counter
|
|
* could not be allocated.
|
|
*/
|
|
__EXPORT extern perf_counter_t perf_alloc(enum perf_counter_type type, const char *name);
|
|
|
|
/**
|
|
* Free a counter.
|
|
*
|
|
* @param handle The performance counter's handle.
|
|
*/
|
|
__EXPORT extern void perf_free(perf_counter_t handle);
|
|
|
|
/**
|
|
* Count a performance event.
|
|
*
|
|
* This call only affects counters that take single events; PC_COUNT etc.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_count(perf_counter_t handle);
|
|
|
|
/**
|
|
* Begin a performance event.
|
|
*
|
|
* This call applies to counters that operate over ranges of time; PC_ELAPSED etc.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_begin(perf_counter_t handle);
|
|
|
|
/**
|
|
* End a performance event.
|
|
*
|
|
* This call applies to counters that operate over ranges of time; PC_ELAPSED etc.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_end(perf_counter_t handle);
|
|
|
|
|
|
/**
|
|
* Print one performance counter.
|
|
*
|
|
* @param handle The counter to print.
|
|
*/
|
|
__EXPORT extern void perf_print_counter(perf_counter_t handle);
|
|
|
|
/**
|
|
* Print all of the performance counters.
|
|
*/
|
|
__EXPORT extern void perf_print_all(void);
|
|
|
|
__END_DECLS
|
|
|
|
#endif
|