forked from Imagelibrary/rtems
2002-05-16 Chris Johns <ccj@acm.org>
* Per PR194, added the Capture engine. * capture/Makefile.am, capture/README, capture/capture-cli.c, capture/capture-cli.h, capture/capture.c, capture/capture.h, capture/.cvsignore: New files. * Makefile.am, configure.ac, wrapup/Makefile.am: Modified to reflect addition.
This commit is contained in:
@@ -1,3 +1,12 @@
|
||||
2002-05-16 Chris Johns <ccj@acm.org>
|
||||
|
||||
* Per PR194, added the Capture engine.
|
||||
* capture/Makefile.am, capture/README, capture/capture-cli.c,
|
||||
capture/capture-cli.h, capture/capture.c, capture/capture.h,
|
||||
capture/.cvsignore: New files.
|
||||
* Makefile.am, configure.ac, wrapup/Makefile.am: Modified to
|
||||
reflect addition.
|
||||
|
||||
2001-05-14 Joel Sherrill <joel@OARcorp.com>
|
||||
|
||||
* dummy/Makefile.am, wrapup/Makefile.am: Fixed to generate
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
|
||||
ACLOCAL_AMFLAGS = -I ../../../aclocal
|
||||
|
||||
SUBDIRS = devnull dummy dumpbuf stackchk monitor cpuuse shell rtmonuse rootfs untar \
|
||||
mw-fb wrapup
|
||||
SUBDIRS = capture cpuuse devnull dummy dumpbuf monitor mw-fb shell rootfs \
|
||||
rtmonuse stackchk untar wrapup
|
||||
|
||||
EXTRA_DIST = README
|
||||
|
||||
|
||||
2
c/src/libmisc/capture/.cvsignore
Normal file
2
c/src/libmisc/capture/.cvsignore
Normal file
@@ -0,0 +1,2 @@
|
||||
Makefile
|
||||
Makefile.in
|
||||
44
c/src/libmisc/capture/Makefile.am
Normal file
44
c/src/libmisc/capture/Makefile.am
Normal file
@@ -0,0 +1,44 @@
|
||||
##
|
||||
## $Id$
|
||||
##
|
||||
|
||||
AUTOMAKE_OPTIONS = foreign 1.4
|
||||
|
||||
include_rtemsdir = $(includedir)/rtems
|
||||
|
||||
LIBNAME = libcapture-tmp
|
||||
LIB = $(ARCH)/$(LIBNAME).a
|
||||
|
||||
C_FILES = capture.c capture-cli.c
|
||||
C_O_FILES = $(C_FILES:%.c=$(ARCH)/%.o)
|
||||
|
||||
include_rtems_HEADERS = capture.h capture-cli.h
|
||||
|
||||
OBJS = $(C_O_FILES)
|
||||
|
||||
include $(RTEMS_ROOT)/make/custom/@RTEMS_BSP@.cfg
|
||||
include $(top_srcdir)/../../../automake/compile.am
|
||||
include $(top_srcdir)/../../../automake/lib.am
|
||||
|
||||
$(PROJECT_INCLUDE)/rtems:
|
||||
@$(mkinstalldirs) $@
|
||||
$(PROJECT_INCLUDE)/rtems/%.h: %.h
|
||||
$(INSTALL_DATA) $< $@
|
||||
|
||||
#
|
||||
# (OPTIONAL) Add local stuff here using +=
|
||||
#
|
||||
|
||||
$(LIB): $(OBJS)
|
||||
$(make-library)
|
||||
|
||||
PREINSTALL_FILES = $(PROJECT_INCLUDE)/rtems \
|
||||
$(include_rtems_HEADERS:%=$(PROJECT_INCLUDE)/rtems/%)
|
||||
|
||||
all-local: $(ARCH) $(PREINSTALL_FILES) $(OBJS) $(LIB)
|
||||
|
||||
.PRECIOUS: $(LIB)
|
||||
|
||||
EXTRA_DIST = README capture.c capture-cli.c
|
||||
|
||||
include $(top_srcdir)/../../../automake/local.am
|
||||
255
c/src/libmisc/capture/README
Normal file
255
c/src/libmisc/capture/README
Normal file
@@ -0,0 +1,255 @@
|
||||
#
|
||||
# $Id$
|
||||
#
|
||||
|
||||
RTEMS Performance Monitoring and Measurement Framework
|
||||
|
||||
Copyright 2002 Chris Johns (ccj@acm.org)
|
||||
23 April 2002
|
||||
|
||||
This directory contains the source code for the performance monitoring and
|
||||
measurement framework. It is more commonly know as the capture engine.
|
||||
|
||||
The capture engine is in an early phase of development. Please review the Status
|
||||
section of this document for the current status.
|
||||
|
||||
Performance.
|
||||
|
||||
The capture engine is designed to not effect the system it is
|
||||
monitoring. Resources such as memory are used as well as a small performance
|
||||
hit in task creation, deletion and context switch. The overhead is small and
|
||||
will not be noticed unless the system is operating close to the performance
|
||||
limit of the target.
|
||||
|
||||
Structure.
|
||||
|
||||
The capture engine is implemented in a couple of layers. This lowest layer is
|
||||
the capture engine. Its interface is in the file 'capture.h'. Typically this
|
||||
interface is directly used unless you are implementing a target interface. The
|
||||
user interface is via a target interface.
|
||||
|
||||
Command Line Interface (CLI).
|
||||
|
||||
This is a target interface that provides a number of user commands via the
|
||||
RTEMS monitor. To use you need to provide the following in your
|
||||
application initialisation:
|
||||
|
||||
#include <rtems/monitor.h>
|
||||
#include <rtems/capture-cli.h>
|
||||
|
||||
rtems_monitor_init (0);
|
||||
rtems_capture_cli_init (0);
|
||||
|
||||
Check the file capture-cli.h for documentation of the interface. The parameter
|
||||
is a pointer to your board support package's time stamp handler. The time stamp
|
||||
handler is yet to be tested so it is recommended this is left as 0, unless you
|
||||
wish to test this part of the engine.
|
||||
|
||||
The commands are:
|
||||
|
||||
copen - Open the capture engine.
|
||||
cclose - Close the capture engine.
|
||||
cenable - Enable the capture engine.
|
||||
cdisable - Disable the capture engine.
|
||||
ctlist - List the tasks known to the capture engine.
|
||||
ctload - Display the current load (sort of top).
|
||||
cwlist - List the watch and trigger controls.
|
||||
cwadd - Add a watch.
|
||||
cwdel - Delete a watch.
|
||||
cwctl - Enable or disable a watch.
|
||||
cwglob - Enable or disable the global watch.
|
||||
cwceil - Set the watch ceiling.
|
||||
cwfloor - Set the watch floor.
|
||||
ctrace - Dump the trace records.
|
||||
ctrig - Define a trigger.
|
||||
|
||||
Open
|
||||
|
||||
usage: copen [-i] size
|
||||
|
||||
Open the capture engine. The size parameter is the size of the capture engine
|
||||
trace buffer. A single record hold a single event, for example a task create or
|
||||
a context in or out. The option '-i' will enable the capture engine after it is
|
||||
opened.
|
||||
|
||||
Close
|
||||
|
||||
usage: cclose
|
||||
|
||||
Close the capture engine and release all resources held by the capture engine.
|
||||
|
||||
Enable
|
||||
|
||||
usage: cenable
|
||||
|
||||
Enable the capture engine if it has been opened.
|
||||
|
||||
Disable
|
||||
|
||||
usage: cdisable
|
||||
|
||||
Disable the capture engine. The enable and disable commands provide a means of
|
||||
removing the overhead of the capture engine from the context switch. This may
|
||||
be needed when testing if it is felt the capture engines overhead is effecting
|
||||
the system.
|
||||
|
||||
Task List
|
||||
|
||||
usage: ctlist
|
||||
|
||||
List the tasks the capture engine knows about. This may contain tasks that have
|
||||
been deleted.
|
||||
|
||||
Task Load
|
||||
|
||||
usage: ctload
|
||||
|
||||
List the tasks in the order of load in a similar way top does on Unix. The
|
||||
command sends ANSI terminal codes. You press enter to stop the update. The
|
||||
update period is fixed at 5 seconds. The output looks like:
|
||||
|
||||
Press ENTER to exit.
|
||||
|
||||
PID NAME RPRI CPRI STATE %CPU %STK FLGS EXEC TIME
|
||||
04010001 IDLE 255 255 READY 96.012% 0% a-----g 1
|
||||
08010009 CPlt 1 1 READY 3.815% 15% a------ 0
|
||||
08010003 ntwk 20 20 Wevnt 0.072% 0% at----g 0
|
||||
08010004 CSr0 20 20 Wevnt 0.041% 0% at----g 0
|
||||
08010001 main 250 250 DELAY 0.041% 0% a-----g 0
|
||||
08010008 test 100 100 Wevnt 0.000% 20% at-T-+g 0
|
||||
08010007 test 100 100 Wevnt 0.000% 0% at-T-+g 0
|
||||
08010005 CSt0 20 20 Wevnt 0.000% 0% at----g 0
|
||||
08010006 RMON 1 1 Wsem 0.000% 0% a------ 0
|
||||
|
||||
There are 7 flags and from left to right are:
|
||||
|
||||
1) 'a' the task is active, and 'd' the task has been deleted.
|
||||
2) 't' the task has been traced.
|
||||
3) 'F' the task has a from (TO_ANY) trigger.
|
||||
4) 'T' the task has a to (FROM_ANY) trigger.
|
||||
5) 'E' the task has an edge (FROM_TO) trigger.
|
||||
6) '+' the task as a watch control attached, 'w' a watch is enabled.
|
||||
7) 'g' the task is part of a global trigger.
|
||||
|
||||
The %STK is the percentage of stack used by a task. Currently only tasks
|
||||
created while the capture engine is enabled can be monitored.
|
||||
|
||||
The RPRI is the real priority. This is the priority set for the task. The
|
||||
current priority is the executing priority that may reflect a level set as a
|
||||
result of priority inversion.
|
||||
|
||||
Watch List
|
||||
|
||||
usage: cwlist
|
||||
|
||||
This command lists the watch and trigger controls the capture engine has. A
|
||||
control is a structure used by the capture engine to determine if a task is
|
||||
watched or triggers capturing.
|
||||
|
||||
Watch Add
|
||||
|
||||
usage: cwadd [task name] [id]
|
||||
|
||||
Add a watch for a task. You can provide a name or id or both. A name will cause
|
||||
all tasks with that name to have the watch added. An id results in a watch
|
||||
being for a specific task.
|
||||
|
||||
Using a name is useful when the task is not yet created.
|
||||
|
||||
Watch Delete
|
||||
|
||||
usage: cwdel [task name] [id]
|
||||
|
||||
Delete a watch that has been added.
|
||||
|
||||
Watch Control
|
||||
|
||||
usage: cwctl [task name] [id] on/off
|
||||
|
||||
Enable or disable a watch. The name and id parameters are the same as the watch
|
||||
add command.
|
||||
|
||||
Global Watch
|
||||
|
||||
usage: cwglob on/off
|
||||
|
||||
Enable or disable the global watch. A global watch is an easy way to enable
|
||||
watches for all tasks with real priorities between the watch ceiling and floor
|
||||
priorities.
|
||||
|
||||
Watch Priority Ceiling
|
||||
|
||||
usage: cwceil priority
|
||||
|
||||
Set the watch priority ceiling. All tasks with a priority less than the ceiling
|
||||
priority are not watched. This allow you to ignore high priority system and
|
||||
driver tasks.
|
||||
|
||||
Watch Priority Floor
|
||||
|
||||
usage: cwfloor priority
|
||||
|
||||
Set the watch priority floor. All tasks with a priority greater than the floor
|
||||
priority level are not watched. This allows you to remove tasks such as IDLE
|
||||
from being monitored.
|
||||
|
||||
Trace
|
||||
|
||||
usage: ctrace [-c] [-r records]
|
||||
|
||||
Dump the trace record. The option '-c' will output the records in comma
|
||||
separated variables (CSV). The '-r' option controls the number of records
|
||||
dumped. This can help stop the command looping for-ever.
|
||||
|
||||
Trigger
|
||||
|
||||
usage: ctrig type [from name] [from id] [to name] [to id]
|
||||
|
||||
Set a trigger. The types of triggers are :
|
||||
|
||||
from : trigger on a context switch from a task
|
||||
to : trigger on a context switch to a task
|
||||
edge : trigger on a context switch from a task to a task
|
||||
|
||||
The from and to trigger types requires a task name or task id or both be
|
||||
provided. The edge requires a from name and/or id and a to name and/or id be
|
||||
provided.
|
||||
|
||||
Flush
|
||||
|
||||
usage: cflush [-n]
|
||||
|
||||
Flush the trace record. The option '-n' stops the capture engine be
|
||||
primed. This means an exising trigger state will not be cleared and tracing
|
||||
will continue.
|
||||
|
||||
Status.
|
||||
|
||||
The following is a list of outstanding issues or bugs.
|
||||
|
||||
1) The capture engine does not scan the existing list of tasks in the kernel
|
||||
when initialised. This means tasks that exist but are not active are not
|
||||
seen. Not sure how to implement this one.
|
||||
|
||||
2) The blocking read of trace records has not been completely implemented or
|
||||
tested. This will wait until I complete the csv support for the cli for a
|
||||
serial UI or the tcp server is implemented.
|
||||
|
||||
3) Task control block clean up is not implemented. The control block should be
|
||||
dumped to the trace buffer. This requires extended record formats. This can
|
||||
be implemented using an event flag to indicate an extended record follows
|
||||
the trace record. This would allow a task delete record to be directly
|
||||
followed by the task information.
|
||||
|
||||
4) Complete csv (comma separated variable) support for the CLI.
|
||||
|
||||
5) Implement a tcp server interface.
|
||||
|
||||
6) Complete the capture engine API documentation.
|
||||
|
||||
7) Test the user supplied time stamp handler.
|
||||
|
||||
8) Task name support is only for the rtems_name type. This means the only the
|
||||
classic API tasks are currently supported. Partial support for the different
|
||||
task names is provided how-ever this is not clean and does not support the
|
||||
variable length task name such as found in the POSIX tasks.
|
||||
1406
c/src/libmisc/capture/capture-cli.c
Normal file
1406
c/src/libmisc/capture/capture-cli.c
Normal file
File diff suppressed because it is too large
Load Diff
52
c/src/libmisc/capture/capture-cli.h
Normal file
52
c/src/libmisc/capture/capture-cli.h
Normal file
@@ -0,0 +1,52 @@
|
||||
/*
|
||||
------------------------------------------------------------------------
|
||||
$Id$
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Copyright Objective Design Systems Pty Ltd, 2002
|
||||
All rights reserved Objective Design Systems Pty Ltd, 2002
|
||||
Chris Johns (ccj@acm.org)
|
||||
|
||||
COPYRIGHT (c) 1989-1998.
|
||||
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 Target Interface Command Line Interface. You need
|
||||
start the RTEMS monitor.
|
||||
|
||||
*/
|
||||
|
||||
#ifndef __CAPTURE_CLI_H_
|
||||
#define __CAPTURE_CLI_H_
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <rtems/capture.h>
|
||||
|
||||
/*
|
||||
* rtems_capture_cli_init
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function initialises the command line interface to the capture
|
||||
* engine.
|
||||
*
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_cli_init (rtems_capture_timestamp timestamp);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
1565
c/src/libmisc/capture/capture.c
Normal file
1565
c/src/libmisc/capture/capture.c
Normal file
File diff suppressed because it is too large
Load Diff
869
c/src/libmisc/capture/capture.h
Normal file
869
c/src/libmisc/capture/capture.h
Normal file
@@ -0,0 +1,869 @@
|
||||
/*
|
||||
------------------------------------------------------------------------
|
||||
$Id$
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Copyright Objective Design Systems Pty Ltd, 2002
|
||||
All rights reserved Objective Design Systems Pty Ltd, 2002
|
||||
Chris Johns (ccj@acm.org)
|
||||
|
||||
COPYRIGHT (c) 1989-1998.
|
||||
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 __CAPTURE_H_
|
||||
#define __CAPTURE_H_
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <rtems.h>
|
||||
|
||||
/*
|
||||
* The number of tasks in a trigger group.
|
||||
*/
|
||||
#define RTEMS_CAPTURE_TRIGGER_TASKS (32)
|
||||
|
||||
/*
|
||||
* rtems_capture_control_t
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* RTEMS control holds the trigger and watch configuration for a group of
|
||||
* tasks with the same name.
|
||||
*/
|
||||
typedef struct rtems_capture_control_s
|
||||
{
|
||||
rtems_name name;
|
||||
rtems_id id;
|
||||
rtems_unsigned32 flags;
|
||||
rtems_name from[RTEMS_CAPTURE_TRIGGER_TASKS];
|
||||
rtems_id from_id[RTEMS_CAPTURE_TRIGGER_TASKS];
|
||||
struct rtems_capture_control_s* next;
|
||||
} rtems_capture_control_t;
|
||||
|
||||
/*
|
||||
* Control flags.
|
||||
*/
|
||||
#define RTEMS_CAPTURE_WATCH (1 << 0)
|
||||
#define RTEMS_CAPTURE_FROM_ANY (1 << 1)
|
||||
#define RTEMS_CAPTURE_TO_ANY (1 << 2)
|
||||
#define RTEMS_CAPTURE_FROM_TO (1 << 3)
|
||||
|
||||
/*
|
||||
* rtems_capture_control_t
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* RTEMS capture control provdes the information about a task, along
|
||||
* with its trigger state. The control is referenced by each
|
||||
* capture record. This is* information neeed by the decoder. The
|
||||
* capture record cannot assume the task will exist when the record is
|
||||
* dumped via the target interface so task info needed for tracing is
|
||||
* copied and held here.
|
||||
*
|
||||
* The inline heper functions provide more details about the info
|
||||
* contained in this structure.
|
||||
*
|
||||
* Note, the tracer code exploits the fact an rtems_name is a
|
||||
* 32bit value.
|
||||
*/
|
||||
typedef struct rtems_capture_task_s
|
||||
{
|
||||
rtems_name name;
|
||||
rtems_id id;
|
||||
rtems_unsigned32 flags;
|
||||
rtems_tcb* tcb;
|
||||
rtems_unsigned32 in;
|
||||
rtems_unsigned32 out;
|
||||
rtems_task_priority start_priority;
|
||||
rtems_unsigned32 stack_size;
|
||||
rtems_unsigned32 stack_clean;
|
||||
rtems_unsigned32 ticks;
|
||||
rtems_unsigned32 tick_offset;
|
||||
rtems_unsigned32 ticks_in;
|
||||
rtems_unsigned32 tick_offset_in;
|
||||
rtems_unsigned32 last_ticks;
|
||||
rtems_unsigned32 last_tick_offset;
|
||||
rtems_capture_control_t* control;
|
||||
struct rtems_capture_task_s* next;
|
||||
} rtems_capture_task_t;
|
||||
|
||||
/*
|
||||
* Task flags.
|
||||
*/
|
||||
#define RTEMS_CAPTURE_TRACED (1 << 0)
|
||||
|
||||
/*
|
||||
* rtems_capture_record_t
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* RTEMS capture record. This is a record that is written into
|
||||
* the buffer. The events includes the priority of the task
|
||||
* at the time of the context switch.
|
||||
*/
|
||||
typedef struct rtems_capture_record_s
|
||||
{
|
||||
rtems_capture_task_t* task;
|
||||
rtems_unsigned32 events;
|
||||
rtems_unsigned32 ticks;
|
||||
rtems_unsigned32 tick_offset;
|
||||
} rtems_capture_record_t;
|
||||
|
||||
/*
|
||||
* The capture record event flags.
|
||||
*/
|
||||
#define RTEMS_CAPTURE_REAL_PRI_EVENT_MASK (0x000000ff)
|
||||
#define RTEMS_CAPTURE_CURR_PRI_EVENT_MASK (0x0000ff00)
|
||||
#define RTEMS_CAPTURE_REAL_PRIORITY_EVENT (0)
|
||||
#define RTEMS_CAPTURE_CURR_PRIORITY_EVENT (8)
|
||||
#define RTEMS_CAPTURE_EVENT_START (16)
|
||||
#define RTEMS_CAPTURE_CREATED_BY_EVENT (1 << 16)
|
||||
#define RTEMS_CAPTURE_CREATED_EVENT (1 << 17)
|
||||
#define RTEMS_CAPTURE_STARTED_BY_EVENT (1 << 18)
|
||||
#define RTEMS_CAPTURE_STARTED_EVENT (1 << 19)
|
||||
#define RTEMS_CAPTURE_RESTARTED_BY_EVENT (1 << 20)
|
||||
#define RTEMS_CAPTURE_RESTARTED_EVENT (1 << 21)
|
||||
#define RTEMS_CAPTURE_DELETED_BY_EVENT (1 << 22)
|
||||
#define RTEMS_CAPTURE_DELETED_EVENT (1 << 23)
|
||||
#define RTEMS_CAPTURE_BEGIN_EVENT (1 << 24)
|
||||
#define RTEMS_CAPTURE_EXITTED_EVENT (1 << 25)
|
||||
#define RTEMS_CAPTURE_SWITCHED_OUT_EVENT (1 << 26)
|
||||
#define RTEMS_CAPTURE_SWITCHED_IN_EVENT (1 << 27)
|
||||
#define RTEMS_CAPTURE_TIMESTAMP (1 << 28)
|
||||
#define RTEMS_CAPTURE_EVENT_END (28)
|
||||
|
||||
/*
|
||||
* rtems_capture_trigger_t
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* The types of triggers that exist. FIXME: add more here.
|
||||
*/
|
||||
typedef enum rtems_capture_trigger_t
|
||||
{
|
||||
rtems_capture_to_any,
|
||||
rtems_capture_from_any,
|
||||
rtems_capture_from_to
|
||||
} rtems_capture_trigger_t;
|
||||
|
||||
/*
|
||||
* rtems_capture_timestamp
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This defines the callout handler to obtain a time stamp. The
|
||||
* value returned is time count since the last read.
|
||||
*
|
||||
*/
|
||||
|
||||
typedef void (*rtems_capture_timestamp)
|
||||
(rtems_unsigned32* ticks, rtems_unsigned32* micro);
|
||||
|
||||
/*
|
||||
* rtems_capture_open
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function initialises the realtime trace manager allocating the capture
|
||||
* buffer. It is assumed we have a working heap at stage of initialisation.
|
||||
*
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_open (rtems_unsigned32 size,
|
||||
rtems_capture_timestamp timestamp);
|
||||
|
||||
/*
|
||||
* rtems_capture_close
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function shutdowns the tracer and release any claimed
|
||||
* resources.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_close ();
|
||||
|
||||
/*
|
||||
* rtems_capture_control
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function allows control of tracing at a global level.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_control (rtems_boolean enable);
|
||||
|
||||
/*
|
||||
* rtems_capture_flush
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function flushes the trace buffer. The prime parameter allows the
|
||||
* capture engine to also be primed again.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_flush (rtems_boolean prime);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_add
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function defines a watch for a specific task given a name. A watch
|
||||
* causes it to be traced either in or out of context. The watch can be
|
||||
* optionally enabled or disabled with the set routine. It is disabled by
|
||||
* default.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_add (rtems_name name, rtems_id id);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_del
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function removes a watch for a specific task given a name. The task
|
||||
* description will still exist if referenced by a trace record in the trace
|
||||
* buffer or a global watch is defined.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_del (rtems_name name, rtems_id id);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_set
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function allows control of a watch. The watch can be enabled or
|
||||
* disabled.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_ctrl (rtems_name name, rtems_id id, rtems_boolean enable);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_global
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function allows control of a global watch. The watch can be enabled or
|
||||
* disabled. A global watch configures all tasks below the ceiling and above
|
||||
* the floor to be traced.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_global (rtems_boolean enable);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_global_on
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the global watch state.
|
||||
*/
|
||||
rtems_boolean
|
||||
rtems_capture_watch_global_on ();
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_ceiling
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function sets a watch ceiling. Tasks at or greating that the
|
||||
* ceiling priority are not watched. This is a simple way to monitor
|
||||
* an application and exclude system tasks running at a higher
|
||||
* priority level.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_ceiling (rtems_task_priority ceiling);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_get_ceiling
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function gets the watch ceiling.
|
||||
*/
|
||||
rtems_task_priority
|
||||
rtems_capture_watch_get_ceiling ();
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_floor
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function sets a watch floor. Tasks at or less that the
|
||||
* floor priority are not watched. This is a simple way to monitor
|
||||
* an application and exclude system tasks running at a lower
|
||||
* priority level.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_watch_floor (rtems_task_priority floor);
|
||||
|
||||
/*
|
||||
* rtems_capture_watch_get_floor
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function gets the watch floor.
|
||||
*/
|
||||
rtems_task_priority
|
||||
rtems_capture_watch_get_floor ();
|
||||
|
||||
/*
|
||||
* rtems_capture_set_trigger
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function sets an edge trigger. Left is the left side of
|
||||
* the edge and right is right side of the edge. The trigger type
|
||||
* can be -
|
||||
*
|
||||
* FROM_ANY : a switch from any task to the right side of the edge.
|
||||
* TO_ANY : a switch from the left side of the edge to any task.
|
||||
* FROM_TO : a switch from the left side of the edge to the right
|
||||
* side of the edge.
|
||||
*
|
||||
* This set trigger routine will create a trace control for the
|
||||
* target task. The task list is searched and any existing tasks
|
||||
* are linked to the new control.
|
||||
*
|
||||
* We can have a number of tasks that have the same name so we
|
||||
* search using names. This means a number of tasks can be
|
||||
* linked to single control.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_set_trigger (rtems_name from,
|
||||
rtems_id from_id,
|
||||
rtems_name to,
|
||||
rtems_id to_id,
|
||||
rtems_capture_trigger_t trigger);
|
||||
|
||||
/*
|
||||
* rtems_capture_read
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function reads a number of records from the capture buffer.
|
||||
* The user can optionally block and wait until the buffer as a
|
||||
* specific number of records available or a specific time has
|
||||
* elasped.
|
||||
*
|
||||
* The function returns the number of record that is has that are
|
||||
* in a continous block of memory. If the number of available records
|
||||
* wrap then only those records are provided. This removes the need for
|
||||
* caller to be concerned about buffer wrappings. If the number of
|
||||
* requested records cannot be met due to the wrapping of the records
|
||||
* less than the specified number will be returned.
|
||||
*
|
||||
* The user must release the records. This is achieved with a call to
|
||||
* rtems_capture_release. Calls this function without a release will
|
||||
* result in at least the same number of records being released.
|
||||
*
|
||||
* The 'threshold' parameter is the number of records that must be
|
||||
* captured before returning. If a timeout period is specified (non-0)
|
||||
* any captured records will be returned. These parameters stop
|
||||
* thrashing occuring for a small number of records, yet allows
|
||||
* a user configured latiency to be applied for single events.
|
||||
*
|
||||
* The 'timeout' parameter is in micro-seconds. A value of 0 will disable
|
||||
* the timeout.
|
||||
*
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_read (rtems_unsigned32 threshold,
|
||||
rtems_unsigned32 timeout,
|
||||
rtems_unsigned32* read,
|
||||
rtems_capture_record_t** recs);
|
||||
|
||||
/*
|
||||
* rtems_capture_release
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function releases the requested number of record slots back
|
||||
* to the capture engine. The count must match the number read.
|
||||
*/
|
||||
rtems_status_code
|
||||
rtems_capture_release (rtems_unsigned32 count);
|
||||
|
||||
/*
|
||||
* rtems_capture_tick_time
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the tick period in micro-seconds.
|
||||
*/
|
||||
rtems_unsigned32
|
||||
rtems_capture_tick_time ();
|
||||
|
||||
/*
|
||||
* rtems_capture_tick_time
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the tick period in micro-seconds.
|
||||
*/
|
||||
rtems_unsigned32
|
||||
rtems_capture_tick_time ();
|
||||
|
||||
/*
|
||||
* rtems_capture_event_text
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns a string for an event based on the bit in the
|
||||
* event. The functions takes the bit offset as a number not the bit
|
||||
* set in a bit map.
|
||||
*/
|
||||
const char*
|
||||
rtems_capture_event_text (int event);
|
||||
|
||||
/*
|
||||
* rtems_capture_get_task_list
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the head of the list of tasks that the
|
||||
* capture engine has detected.
|
||||
*/
|
||||
rtems_capture_task_t*
|
||||
rtems_capture_get_task_list ();
|
||||
|
||||
/*
|
||||
* rtems_capture_next_task
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the pointer to the next task in the list. The
|
||||
* pointer NULL terminates the list.
|
||||
*/
|
||||
static inline rtems_capture_task_t*
|
||||
rtems_capture_next_task (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->next;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_valid
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns true if the task control block points to
|
||||
* a valid task.
|
||||
*/
|
||||
static inline rtems_boolean
|
||||
rtems_capture_task_valid (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->tcb != NULL;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_id
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task id.
|
||||
*/
|
||||
static inline rtems_id
|
||||
rtems_capture_task_id (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->id;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_state
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task state.
|
||||
*/
|
||||
static inline States_Control
|
||||
rtems_capture_task_state (rtems_capture_task_t* task)
|
||||
{
|
||||
if (rtems_capture_task_valid (task))
|
||||
return task->tcb->current_state;
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_name
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task name.
|
||||
*/
|
||||
static inline rtems_name
|
||||
rtems_capture_task_name (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->name;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_flags
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task flags.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_flags (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->flags;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_control
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task control if present.
|
||||
*/
|
||||
static inline rtems_capture_control_t*
|
||||
rtems_capture_task_control (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->control;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_control_flags
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task control flags if a control is present.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_control_flags (rtems_capture_task_t* task)
|
||||
{
|
||||
if (!task->control)
|
||||
return 0;
|
||||
return task->control->flags;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_switched_in
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the number of times the task has
|
||||
* been switched into context.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_switched_in (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->in;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_switched_out
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the number of times the task has
|
||||
* been switched out of context.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_switched_out (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->out;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_curr_priority
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the tasks start priority. The tracer needs this
|
||||
* to track where the task's priority goes.
|
||||
*/
|
||||
static inline rtems_task_priority
|
||||
rtems_capture_task_start_priority (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->start_priority;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_real_priority
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the tasks real priority.
|
||||
*/
|
||||
static inline rtems_task_priority
|
||||
rtems_capture_task_real_priority (rtems_capture_task_t* task)
|
||||
{
|
||||
if (rtems_capture_task_valid (task))
|
||||
return task->tcb->real_priority;
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_curr_priority
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the tasks current priority.
|
||||
*/
|
||||
static inline rtems_task_priority
|
||||
rtems_capture_task_curr_priority (rtems_capture_task_t* task)
|
||||
{
|
||||
if (rtems_capture_task_valid (task))
|
||||
return task->tcb->current_priority;
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_stack_usage
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function updates the stack usage. The task control block
|
||||
* is updated.
|
||||
*/
|
||||
rtems_unsigned32
|
||||
rtems_capture_task_stack_usage (rtems_capture_task_t* task);
|
||||
|
||||
/*
|
||||
* rtems_capture_task_stack_size
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the task's stack size.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_stack_size (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->stack_size;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_stack_used
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the amount of stack used.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_stack_used (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->stack_size - task->stack_clean;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_ticks
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the current execution time as ticks.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_ticks (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->ticks;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_tick_offset
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the current execution time tick offset.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_tick_offset (rtems_capture_task_t* task)
|
||||
{
|
||||
return task->tick_offset;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_time
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the current execution time.
|
||||
*/
|
||||
static inline unsigned long long
|
||||
rtems_capture_task_time (rtems_capture_task_t* task)
|
||||
{
|
||||
unsigned long long t = task->ticks;
|
||||
return (t * rtems_capture_tick_time ()) + task->tick_offset;;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_delta_time
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the execution time as a different between the
|
||||
* last time the detla time was and now.
|
||||
*/
|
||||
static inline unsigned long long
|
||||
rtems_capture_task_delta_time (rtems_capture_task_t* task)
|
||||
{
|
||||
unsigned long long t = task->ticks - task->last_ticks;
|
||||
rtems_unsigned32 o = task->tick_offset - task->last_tick_offset;
|
||||
|
||||
task->last_ticks = task->ticks;
|
||||
task->last_tick_offset = task->tick_offset;
|
||||
|
||||
return (t * rtems_capture_tick_time ()) + o;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_task_count
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the number of tasks the capture
|
||||
* engine knows about.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_task_count ()
|
||||
{
|
||||
rtems_capture_task_t* task = rtems_capture_get_task_list ();
|
||||
rtems_unsigned32 count = 0;
|
||||
|
||||
while (task)
|
||||
{
|
||||
count++;
|
||||
task = rtems_capture_next_task (task);
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_get_control_list
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the head of the list of controls in the
|
||||
* capture engine.
|
||||
*/
|
||||
rtems_capture_control_t*
|
||||
rtems_capture_get_control_list ();
|
||||
|
||||
/*
|
||||
* rtems_capture_next_control
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the pointer to the next control in the list. The
|
||||
* pointer NULL terminates the list.
|
||||
*/
|
||||
static inline rtems_capture_control_t*
|
||||
rtems_capture_next_control (rtems_capture_control_t* control)
|
||||
{
|
||||
return control->next;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_id
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the control id.
|
||||
*/
|
||||
static inline rtems_id
|
||||
rtems_capture_control_id (rtems_capture_control_t* control)
|
||||
{
|
||||
return control->id;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_name
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the control name.
|
||||
*/
|
||||
static inline rtems_name
|
||||
rtems_capture_control_name (rtems_capture_control_t* control)
|
||||
{
|
||||
return control->name;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_flags
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the control flags.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_control_flags (rtems_capture_control_t* control)
|
||||
{
|
||||
return control->flags;
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_from_name
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the control from task name.
|
||||
*/
|
||||
static inline rtems_name
|
||||
rtems_capture_control_from_name (rtems_capture_control_t* control, int from)
|
||||
{
|
||||
if (from < RTEMS_CAPTURE_TRIGGER_TASKS)
|
||||
return control->from[from];
|
||||
return control->from[0];
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_from_id
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the control from task id.
|
||||
*/
|
||||
static inline rtems_id
|
||||
rtems_capture_control_from_id (rtems_capture_control_t* control, int from)
|
||||
{
|
||||
if (from < RTEMS_CAPTURE_TRIGGER_TASKS)
|
||||
return control->from_id[from];
|
||||
return control->from_id[0];
|
||||
}
|
||||
|
||||
/*
|
||||
* rtems_capture_control_count
|
||||
*
|
||||
* DESCRIPTION:
|
||||
*
|
||||
* This function returns the number of controls the capture
|
||||
* engine has.
|
||||
*/
|
||||
static inline rtems_unsigned32
|
||||
rtems_capture_control_count ()
|
||||
{
|
||||
rtems_capture_control_t* control = rtems_capture_get_control_list ();
|
||||
rtems_unsigned32 count = 0;
|
||||
|
||||
while (control)
|
||||
{
|
||||
count++;
|
||||
control = rtems_capture_next_control (control);
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
@@ -43,6 +43,7 @@ monitor/Makefile
|
||||
rtmonuse/Makefile
|
||||
rootfs/Makefile
|
||||
stackchk/Makefile
|
||||
capture/Makefile
|
||||
untar/Makefile
|
||||
mw-fb/Makefile
|
||||
wrapup/Makefile
|
||||
|
||||
@@ -19,7 +19,7 @@ TMP_LIBS = ../monitor/$(ARCH)/libmonitor-tmp.a \
|
||||
../cpuuse/$(ARCH)/libcpuuse-tmp.a ../rtmonuse/$(ARCH)/librtmonuse-tmp.a \
|
||||
../shell/$(ARCH)/libshell-tmp.a ../dumpbuf/$(ARCH)/libdumpbuf-tmp.a \
|
||||
../devnull/$(ARCH)/libdevnull-tmp.a ../dummy/$(ARCH)/libdummy-tmp.a \
|
||||
../mw-fb/$(ARCH)/libmw-fb-tmp.a $(NETLIBS)
|
||||
../mw-fb/$(ARCH)/libmw-fb-tmp.a ../capture/$(ARCH)/libcapture-tmp.a
|
||||
|
||||
$(PROJECT_RELEASE)/lib/$(LIBNAME)$(LIB_VARIANT).a: $(LIB)
|
||||
$(INSTALL_DATA) $< $@
|
||||
|
||||
Reference in New Issue
Block a user