mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
de85fbe1dc
<systemlib/err.h> --> "systemlib/err.h" that fix_headers.sh
would miss because it comes after code it doesn't understand.
Effectively remove the '__EXPORT extern perf_counter_t perf_alloc('
line, because currently perf_alloc is defined to be NULL, and
after running fix_headers.sh that happens *before* this header
is included (the order of headers will be changed).
Do not define NULL to be (void*)0: that only works for C.
In fact, the conversions needed for NULL are so full of exceptions
that standard C++ introduced a new *keyword*: nullptr.
That's what we really should be using for C++ code.
In this case I just include the correct header to define NULL
the correct way.
Not really related to the header line:
Removed an #include <time.h> because I noted that px4_time.h
was already included... and moved a #include <sys/time.h>
to the top of the file (not really a fan of including headers
in the middle unless absolutely necessary).
Removed a include of queue.h because I noted it wasn't used.
203 lines
6.2 KiB
C
203 lines
6.2 KiB
C
/****************************************************************************
|
|
*
|
|
* Copyright (C) 2012-2016 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
|
|
|
|
#include <stdint.h>
|
|
#include <px4_defines.h>
|
|
|
|
/**
|
|
* 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 */
|
|
PC_INTERVAL /**< measure the interval between instances of an event */
|
|
};
|
|
|
|
struct perf_ctr_header;
|
|
typedef struct perf_ctr_header *perf_counter_t;
|
|
|
|
__BEGIN_DECLS
|
|
|
|
/**
|
|
* Create a new local 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.
|
|
*/
|
|
#ifndef perf_alloc // perf_alloc might be defined to be NULL in src/modules/px4iofirmware/px4io.h
|
|
__EXPORT extern perf_counter_t perf_alloc(enum perf_counter_type type, const char *name);
|
|
#endif
|
|
|
|
/**
|
|
* Get the reference to an existing counter or create a new one if it does not exist.
|
|
*
|
|
* @param type The type of the counter.
|
|
* @param name The counter name.
|
|
* @return Handle for the counter, or NULL if a counter
|
|
* could not be allocated.
|
|
*/
|
|
__EXPORT extern perf_counter_t perf_alloc_once(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, PC_INTERVAL 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.
|
|
* If a call is made without a corresponding perf_begin call, or if perf_cancel
|
|
* has been called subsequently, no change is made to the counter.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_end(perf_counter_t handle);
|
|
|
|
/**
|
|
* Register a measurement
|
|
*
|
|
* This call applies to counters that operate over ranges of time; PC_ELAPSED etc.
|
|
* If a call is made without a corresponding perf_begin call. It sets the
|
|
* value provided as argument as a new measurement.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
* @param elapsed The time elapsed. Negative values lead to incrementing the overrun counter.
|
|
*/
|
|
__EXPORT extern void perf_set_elapsed(perf_counter_t handle, int64_t elapsed);
|
|
|
|
/**
|
|
* Set a counter
|
|
*
|
|
* This call applies to counters of type PC_COUNT. It (re-)sets the count.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
* @param count The counter value to be set.
|
|
*/
|
|
__EXPORT extern void perf_set_count(perf_counter_t handle, uint64_t count);
|
|
|
|
/**
|
|
* Cancel a performance event.
|
|
*
|
|
* This call applies to counters that operate over ranges of time; PC_ELAPSED etc.
|
|
* It reverts the effect of a previous perf_begin.
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_cancel(perf_counter_t handle);
|
|
|
|
/**
|
|
* Reset a performance counter.
|
|
*
|
|
* This call resets performance counter to initial state
|
|
*
|
|
* @param handle The handle returned from perf_alloc.
|
|
*/
|
|
__EXPORT extern void perf_reset(perf_counter_t handle);
|
|
|
|
/**
|
|
* Print one performance counter to stdout
|
|
*
|
|
* @param handle The counter to print.
|
|
*/
|
|
__EXPORT extern void perf_print_counter(perf_counter_t handle);
|
|
|
|
/**
|
|
* Print one performance counter to a fd.
|
|
*
|
|
* @param fd File descriptor to print to - e.g. 0 for stdout
|
|
* @param handle The counter to print.
|
|
*/
|
|
__EXPORT extern void perf_print_counter_fd(int fd, perf_counter_t handle);
|
|
|
|
/**
|
|
* Print all of the performance counters.
|
|
*
|
|
* @param fd File descriptor to print to - e.g. 0 for stdout
|
|
*/
|
|
__EXPORT extern void perf_print_all(int fd);
|
|
|
|
/**
|
|
* Print hrt latency counters.
|
|
*
|
|
* @param fd File descriptor to print to - e.g. 0 for stdout
|
|
*/
|
|
__EXPORT extern void perf_print_latency(int fd);
|
|
|
|
/**
|
|
* Reset all of the performance counters.
|
|
*/
|
|
__EXPORT extern void perf_reset_all(void);
|
|
|
|
/**
|
|
* Return current event_count
|
|
*
|
|
* @param handle The counter returned from perf_alloc.
|
|
* @return event_count
|
|
*/
|
|
__EXPORT extern uint64_t perf_event_count(perf_counter_t handle);
|
|
|
|
__END_DECLS
|
|
|
|
#endif
|