capture.c File Reference

#include <stdlib.h>
#include <string.h>
#include "captureimpl.h"
#include "capture_buffer.h"
#include <rtems/score/statesimpl.h>
#include <rtems/score/todimpl.h>

Include dependency graph for capture.c:

Data Structures
struct	rtems_capture_per_cpu_data
struct	rtems_capture_global_data

Macros
#define	RTEMS_CAPTURE_RECORD_EVENTS   (0)
#define	capture_per_cpu_get(_cpu)   ( &capture_per_cpu[ _cpu ] )
#define	capture_records_on_cpu(_cpu)   capture_per_cpu[ _cpu ].records
#define	capture_count_on_cpu(_cpu)   capture_per_cpu[ _cpu ].count
#define	capture_flags_on_cpu(_cpu)   capture_per_cpu[ _cpu ].flags
#define	capture_reader_on_cpu(_cpu)   capture_per_cpu[ _cpu ].reader
#define	capture_lock_on_cpu(_cpu)   capture_per_cpu[ _cpu ].lock
#define	capture_records   capture_records_on_cpu( _SMP_Get_current_processor() )
#define	capture_count   capture_count_on_cpu( _SMP_Get_current_processor() )
#define	capture_flags_per_cpu   capture_flags_on_cpu( _SMP_Get_current_processor() )
#define	capture_flags_global   capture_global.flags
#define	capture_controls   capture_global.controls
#define	capture_extension_index   capture_global.extension_index
#define	capture_timestamp   capture_global.timestamp
#define	capture_ceiling   capture_global.ceiling
#define	capture_floor   capture_global.floor
#define	capture_reader   capture_reader_on_cpu( _SMP_Get_current_processor() )
#define	capture_lock_per_cpu   capture_lock_on_cpu( _SMP_Get_current_processor() )
#define	capture_lock_global   capture_global.lock

Functions
void	rtems_capture_set_extension_index (int index)
	Capture set extension index. More...
int	rtems_capture_get_extension_index (void)
	Capture get extension index. More...
uint32_t	rtems_capture_get_flags (void)
	Capture get flags. More...
void	rtems_capture_set_flags (uint32_t mask)
	Capture set flags. More...
void	rtems_capture_get_time (rtems_capture_time_t *time)
	Capture returns the current time. More...
void	rtems_capture_initialize_task (rtems_tcb *tcb)
	Capture initialize task. More...
void	rtems_capture_record_task (rtems_tcb *tcb)
	Capture record task. More...
bool	rtems_capture_filter (rtems_tcb *tcb, uint32_t events)
	Capture filter. More...
void *	rtems_capture_record_open (rtems_tcb *tcb, uint32_t events, size_t size, rtems_interrupt_lock_context *lock_context)
	Capture record open. More...
void	rtems_capture_record_close (void *rec, rtems_interrupt_lock_context *lock_context)
	Capture record close. More...
bool	rtems_capture_trigger (rtems_tcb *ft, rtems_tcb *tt, uint32_t events)
	Capture trigger. More...
rtems_status_code	rtems_capture_open (uint32_t size, rtems_capture_timestamp timestamp)
	Capture open. More...
rtems_status_code	rtems_capture_close (void)
	Capture close. More...
rtems_status_code	rtems_capture_control (bool enable)
	Capture control trace enable/disable. More...
rtems_status_code	rtems_capture_monitor (bool enable)
	Capture monitor enable/disable. More...
rtems_status_code	rtems_capture_flush (bool prime)
rtems_status_code	rtems_capture_watch_add (rtems_name name, rtems_id id)
	Capture add watch. More...
rtems_status_code	rtems_capture_watch_del (rtems_name name, rtems_id id)
	Capture delete watch. More...
rtems_status_code	rtems_capture_watch_ctrl (rtems_name name, rtems_id id, bool enable)
	Capture enable/disable watch. More...
rtems_status_code	rtems_capture_watch_global (bool enable)
	Capture enable/disable global watch. More...
bool	rtems_capture_watch_global_on (void)
	Get global watch state. More...
rtems_status_code	rtems_capture_watch_ceiling (rtems_task_priority ceiling)
	Set watch ceiling. More...
rtems_task_priority	rtems_capture_watch_get_ceiling (void)
	Get watch ceiling. More...
rtems_status_code	rtems_capture_watch_floor (rtems_task_priority floor)
	Capture set watch floor. More...
rtems_task_priority	rtems_capture_watch_get_floor (void)
	Capture set watch floor. More...
rtems_status_code	rtems_capture_set_trigger (rtems_name from_name, rtems_id from_id, rtems_name to_name, rtems_id to_id, rtems_capture_trigger_mode_t mode, rtems_capture_trigger_t trigger)
	Capture set trigger. More...
rtems_status_code	rtems_capture_clear_trigger (rtems_name from_name, rtems_id from_id, rtems_name to_name, rtems_id to_id, rtems_capture_trigger_mode_t mode, rtems_capture_trigger_t trigger)
	Capture clear trigger. More...
rtems_status_code	rtems_capture_read (uint32_t cpu, uint32_t *read, rtems_capture_record_t **recs)
	Capture read records from capture buffer. More...
rtems_status_code	rtems_capture_release (uint32_t cpu, uint32_t count)
	Capture release records. More...
void	rtems_capture_time (rtems_capture_time_t *uptime)
const char *	rtems_capture_event_text (int event)
	Capture get event text. More...
rtems_capture_control_t *	rtems_capture_get_control_list (void)
	Capture get control list. More...

Function Documentation

rtems_capture_filter()

bool rtems_capture_filter	(	rtems_tcb *	task,
		uint32_t	events
	)

Capture filter.

This function this function specifies if the given task and events should be logged.

Parameters

[in]	task	specifies the capture task control block
[in]	events	specifies the events

Return values

This	method returns true if this data should be filtered from the log. It returns false if this data should be logged.

rtems_capture_get_extension_index()

int rtems_capture_get_extension_index

(

void

)

Capture get extension index.

This function rturns the extension index for the capture engine.

Return values

This	method returns the extension index.

rtems_capture_get_flags()

uint32_t rtems_capture_get_flags

(

void

)

Capture get flags.

This function gets the current flag settings for the capture engine.

Return values

This	method returns the global capture flags.

rtems_capture_get_time()

void rtems_capture_get_time

(

rtems_capture_time_t *

time

)

Capture returns the current time.

This function returns the current time. If a handler is provided by the user the time is gotten from that.

Parameters

[in]

time

specifies the capture time

Return values

This	method returns a nano-second time if no user handler is provided. Otherwise, it returns a resolution defined by the handler.

rtems_capture_record_close()

void rtems_capture_record_close	(	void *	rec,
		rtems_interrupt_lock_context *	lock_context
	)

Capture record close.

This function closes writing to capure record and releases the lock that was held on the record. This method should only be used by rtems_capture_end_add_record.

Parameters

[in]	rec	specifies the record
[out]	lock_context	specifies the lock context

References rtems_interrupt_lock_release.

rtems_capture_record_open()

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

Capture record open.

This function allocates a record and fills in the header information. It does a lock acquire which will remain in effect until rtems_capture_record_close is called. This method should only be used by rtems_capture_begin_add_record.

Parameters

[in]	task	specifies the caputre task block
[in]	events	specifies the events
[in]	size	specifies capture record size
[out]	lock_context	specifies the lock context

Return values

This	method returns a pointer to the next location in the capture record to store data.

rtems_capture_set_extension_index()

void rtems_capture_set_extension_index

(

int

index

)

Capture set extension index.

This function is used to set the extension index for the capture engine.

Parameters

[in]

index

specifies the extension index to be used for capture engine data.

rtems_capture_set_flags()

void rtems_capture_set_flags

(

uint32_t

mask

)

Capture set flags.

This function sets a flag in the capture engine

Parameters

[in]

mask

specifies the flag to set

rtems_capture_trigger()

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

Capture trigger.

This function checks if we have triggered or if this event is a cause of a trigger.

Parameters

[in]	ft	specifies specifices the capture from task
[in]	tt	specifies specifices the capture to task
[in]	events	specifies the events

Return values

This	method returns true if we have triggered or if the event is a cause of a trigger.