captureimpl.h

Go to the documentation of this file.

/*
  ------------------------------------------------------------------------

  Copyright Objective Design Systems Pty Ltd, 2002
  All rights reserved Objective Design Systems Pty Ltd, 2002
  Chris Johns (ccj@acm.org)

  COPYRIGHT (c) 1989-2014.
  On-Line Applications Research Corporation (OAR).

  The license and distribution terms for this file may be
  found in the file LICENSE in this distribution.

  This software with is provided ``as is'' and with NO WARRANTY.

  ------------------------------------------------------------------------

  RTEMS Performance Monitoring and Measurement Framework.
  This is the Capture Engine component.

*/

#ifndef __CAPTUREIMPL_H_
#define __CAPTUREIMPL_H_


#ifdef __cplusplus
extern "C" {
#endif

#include "capture.h"

/*
 * Global capture flags.
 */
#define RTEMS_CAPTURE_INIT           (1u << 0)
#define RTEMS_CAPTURE_ON             (1U << 1)
#define RTEMS_CAPTURE_NO_MEMORY      (1U << 2)
#define RTEMS_CAPTURE_TRIGGERED      (1U << 3)
#define RTEMS_CAPTURE_GLOBAL_WATCH   (1U << 4)
#define RTEMS_CAPTURE_ONLY_MONITOR   (1U << 5)

/*
 * Per-CPU capture flags.
 */
#define RTEMS_CAPTURE_OVERFLOW       (1U << 0)
#define RTEMS_CAPTURE_READER_ACTIVE  (1U << 1)
#define RTEMS_CAPTURE_READER_WAITING (1U << 2)

void rtems_capture_set_extension_index(int index);

int  rtems_capture_get_extension_index(void);

uint32_t rtems_capture_get_flags(void);

void rtems_capture_set_flags(uint32_t mask);

rtems_status_code rtems_capture_user_extension_open(void);

rtems_status_code rtems_capture_user_extension_close(void);

bool rtems_capture_trigger (rtems_tcb* ft,
                            rtems_tcb* tt,
                            uint32_t   events);

static void *rtems_capture_append_to_record(void*  rec,
                                     void*  data,
                                     size_t size );

bool rtems_capture_filter( rtems_tcb*            task,
                           uint32_t              events);
#define rtems_capture_begin_add_record( _task, _events, _size, _rec) \
  do { \
    rtems_interrupt_lock_context _lock_context; \
    *_rec = rtems_capture_record_open( _task, _events, _size, &_lock_context );

static inline void *rtems_capture_append_to_record(void*  rec,
                                                   void*  data,
                                                   size_t size )
{
  uint8_t *ptr = rec;
  memcpy( ptr, data, size );
  return (ptr + size);
}

#define rtems_capture_end_add_record( _rec ) \
    rtems_capture_record_close( _rec, &_lock_context ); \
  } while (0)

void rtems_capture_get_time (rtems_capture_time_t* time);

void* rtems_capture_record_open (rtems_tcb*                    task,
                                 uint32_t                      events,
                                 size_t                        size,
                                 rtems_interrupt_lock_context* lock_context);
void rtems_capture_record_close( void *rec, rtems_interrupt_lock_context* lock_context);


void rtems_capture_print_trace_records ( int total, bool csv );

void rtems_capture_print_timestamp (uint64_t uptime);

void rtems_capture_print_record_task(
  uint32_t                cpu,
  rtems_capture_record_t* rec
);

void rtems_capture_print_record_capture(
  uint32_t                cpu,
  rtems_capture_record_t* rec,
  uint64_t                diff
);

void rtems_capture_print_watch_list( void );

#ifdef __cplusplus
}
#endif

#endif