profiling.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (c) 2014 embedded brains GmbH & Co. KG
 *
 * 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.
 *
 * 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.
 */
 
#ifndef _RTEMS_PROFILING_H
#define _RTEMS_PROFILING_H
 
#include <stdint.h>
 
#include <rtems/print.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum {
  RTEMS_PROFILING_PER_CPU,
 
  RTEMS_PROFILING_SMP_LOCK
} rtems_profiling_type;
 
typedef struct {
  rtems_profiling_type type;
} rtems_profiling_header;
 
typedef struct {
  rtems_profiling_header header;
 
  uint32_t processor_index;
 
  uint32_t max_thread_dispatch_disabled_time;
 
  uint64_t thread_dispatch_disabled_count;
 
  uint64_t total_thread_dispatch_disabled_time;
 
  uint32_t max_interrupt_delay;
 
  uint32_t max_interrupt_time;
 
  uint64_t interrupt_count;
 
  uint64_t total_interrupt_time;
} rtems_profiling_per_cpu;
 
#define RTEMS_PROFILING_SMP_LOCK_CONTENTION_COUNTS 4
 
typedef struct {
  rtems_profiling_header header;
 
  const char *name;
 
  uint32_t max_acquire_time;
 
  uint32_t max_section_time;
 
  uint64_t usage_count;
 
  uint64_t total_acquire_time;
 
  uint64_t total_section_time;
 
  uint64_t contention_counts[RTEMS_PROFILING_SMP_LOCK_CONTENTION_COUNTS];
} rtems_profiling_smp_lock;
 
typedef union {
  rtems_profiling_header header;
 
  rtems_profiling_per_cpu per_cpu;
 
  rtems_profiling_smp_lock smp_lock;
} rtems_profiling_data;
 
typedef void (*rtems_profiling_visitor)(
  void *arg,
  const rtems_profiling_data *data
);
 
void rtems_profiling_iterate(
  rtems_profiling_visitor visitor,
  void *visitor_arg
);
 
int rtems_profiling_report_xml(
  const char *name,
  const rtems_printer *printer,
  uint32_t indentation_level,
  const char *indentation
);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _RTEMS_PROFILING_H */