source: rtems/cpukit/libmisc/monitor/README @ b06e68ef

4.104.114.84.95
Last change on this file since b06e68ef was b06e68ef, checked in by Joel Sherrill <joel.sherrill@…>, on Aug 17, 1995 at 7:51:51 PM

Numerous miscellaneous features incorporated from Tony Bennett
(tbennett@…) including the following major additions:

+ variable length messages
+ named devices
+ debug monitor
+ association tables/variables

  • Property mode set to 100644
File size: 2.9 KB
Line 
1#
2#  $Id$
3#
4
5monitor task
6
7The monitor task is an optional task that knows about RTEMS
8data structures and can print out information about them.
9It is a work-in-progress and needs many more commands, but
10is useful now.
11
12The monitor works best when it is the highest priority task,
13so all your other tasks should ideally be at some priority
14greater than 1.
15
16To use the monitor:
17-------------------
18
19    #include <rtems/monitor.h>
20
21        ...
22
23    rtems_monitor_init(0);
24
25    The parameter to rtems_monitor_init() tells the monitor whether
26    to suspend itself on startup.  A value of 0 causes the monitor
27    to immediately enter command mode; a non-zero value causes the
28    monitor to suspend itself after creation and wait for explicit
29    wakeup.
30
31
32    rtems_monitor_wakeup();
33   
34    wakes up a suspended monitor and causes it to reenter command mode.
35
36Monitor commands
37----------------
38
39    The monitor prompt is 'rtems> '.
40    Can abbreviate commands to "uniquity"
41    There is a 'help' command.  Here is the output from various
42    help commands:
43
44        Commands (may be abbreviated)
45
46          help      -- get this message or command specific help
47          task      -- show task information
48          queue     -- show message queue information
49          symbol    -- show entries from symbol table
50          pause     -- pause monitor for a specified number of ticks
51          fatal     -- invoke a fatal RTEMS error
52
53        task [id [id ...] ]
54          display information about the specified tasks.
55          Default is to display information about all tasks on this node
56
57        queue [id [id ... ] ]
58          display information about the specified message queues
59          Default is to display information about all queues on this node
60
61        symbol [ symbolname [symbolname ... ] ]
62          display value associated with specified symbol.
63          Defaults to displaying all known symbols.
64
65        pause [ticks]
66          monitor goes to "sleep" for specified ticks (default is 1)
67          monitor will resume at end of period or if explicitly awakened
68
69        fatal [status]
70          Invoke 'rtems_fatal_error_occurred' with 'status'
71          (default is RTEMS_INTERNAL_ERROR)
72
73        continue
74          put the monitor to sleep waiting for an explicit wakeup from the
75          program running.
76
77
78Sample output from 'task' command
79---------------------------------
80
81    rtems> task
82      ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
83    ------------------------------------------------------------------------
84    00010001   UI1     2    READY    P:T:nA    NONE15: 0x40606348
85    00010002   RMON    1    READY    nP    NONE15: 0x40604110
86
87    'RMON' is the monitor itself, so we have 1 "user" task.
88    Its modes are P:T:nA which translate to:
89
90        preemptable
91        timesliced
92        no ASRS
93
94    It has no events.
95    It has a notepad value for notepad 15 which is 0x40606348
96    (this is the libc thread state)
97
Note: See TracBrowser for help on using the repository browser.