source: rtems/cpukit/libmisc/monitor/monitor.h @ 5b331cc5

4.104.11
Last change on this file since 5b331cc5 was 5b331cc5, checked in by Ralf Corsepius <ralf.corsepius@…>, on Apr 12, 2010 at 3:23:41 PM

Add rtems_monitor_dump_addr().

  • Property mode set to 100644
File size: 17.9 KB
Line 
1/**
2 * @file rtems/monitor.h
3 *
4 * The RTEMS monitor task.
5 */
6
7/*
8 *  $Id$
9 */
10
11#ifndef __MONITOR_H
12#define __MONITOR_H
13
14#include <rtems/error.h>  /* rtems_error() */
15#include <rtems/config.h>
16
17#ifdef __cplusplus
18extern "C" {
19#endif
20
21/* Forward decls from symbols.h */
22typedef struct _rtems_symbol_t rtems_symbol_t;
23typedef struct _rtems_symbol_table_t rtems_symbol_table_t;
24
25/*
26 * Monitor types are derived from rtems object classes
27 */
28
29typedef enum {
30    RTEMS_MONITOR_OBJECT_INVALID   =  OBJECTS_CLASSIC_NO_CLASS,
31    RTEMS_MONITOR_OBJECT_TASK      =  OBJECTS_RTEMS_TASKS,
32    RTEMS_MONITOR_OBJECT_EXTENSION =  OBJECTS_RTEMS_EXTENSIONS,
33    RTEMS_MONITOR_OBJECT_QUEUE     =  OBJECTS_RTEMS_MESSAGE_QUEUES,
34    RTEMS_MONITOR_OBJECT_SEMAPHORE =  OBJECTS_RTEMS_SEMAPHORES,
35    RTEMS_MONITOR_OBJECT_PARTITION =  OBJECTS_RTEMS_PARTITIONS,
36    RTEMS_MONITOR_OBJECT_REGION    =  OBJECTS_RTEMS_REGIONS,
37    RTEMS_MONITOR_OBJECT_PORT      =  OBJECTS_RTEMS_PORTS,
38
39    /* following monitor objects are not known to RTEMS, but
40     * we like to have "types" for them anyway */
41
42    RTEMS_MONITOR_OBJECT_DRIVER    =  OBJECTS_RTEMS_CLASSES_LAST+1,
43    RTEMS_MONITOR_OBJECT_DNAME,
44    RTEMS_MONITOR_OBJECT_CONFIG,
45    RTEMS_MONITOR_OBJECT_INIT_TASK,
46    RTEMS_MONITOR_OBJECT_MPCI,
47    RTEMS_MONITOR_OBJECT_SYMBOL,
48    #if defined(RTEMS_POSIX_API)
49      RTEMS_MONITOR_OBJECT_PTHREAD,
50    #endif
51} rtems_monitor_object_type_t;
52
53/*
54 * rtems_monitor_init() flags
55 */
56
57#define RTEMS_MONITOR_SUSPEND   0x0001          /* suspend monitor on startup */
58#define RTEMS_MONITOR_GLOBAL    0x0002          /* monitor should be global */
59#define RTEMS_MONITOR_NOTASK    0x0004 /* do not start monitor task */
60#define RTEMS_MONITOR_NOSYMLOAD 0x0008 /* do not load symbols       */
61#define RTEMS_MONITOR_WAITQUIT  0x0010 /* wait for monitor task to terminate */
62
63/*
64 * Public interfaces for RTEMS data structures monitor is aware of.
65 * These are only used by the monitor.
66 *
67 * NOTE:
68 *  All the canonical objects that correspond to RTEMS managed "objects"
69 *  must have an identical first portion with 'id' and 'name' fields.
70 *
71 *  Others do not have that restriction, even tho we would like them to.
72 *  This is because some of the canonical structures are almost too big
73 *  for shared memory driver (eg: mpci) and we are nickel and diming it.
74 */
75
76/*
77 * Type of a pointer that may be a symbol
78 */
79
80#define MONITOR_SYMBOL_LEN 20
81typedef struct {
82    char       name[MONITOR_SYMBOL_LEN];
83    uint32_t   value;
84    uint32_t   offset;
85} rtems_monitor_symbol_t;
86
87typedef struct {
88    rtems_id            id;
89    rtems_name          name;
90  /* end of common portion */
91} rtems_monitor_generic_t;
92
93/*
94 * Task
95 */
96typedef struct {
97    rtems_id                   id;
98    rtems_name                 name;
99  /* end of common portion */
100    Thread_Entry               entry;
101    Thread_Entry_numeric_type  argument;
102    void                      *stack;
103    uint32_t                   stack_size;
104    rtems_task_priority        priority;
105    States_Control             state;
106    rtems_event_set            events;
107    rtems_mode                 modes;
108    rtems_attribute            attributes;
109    uint32_t                   notepad[RTEMS_NUMBER_NOTEPADS];
110    rtems_id                   wait_id;
111    uint32_t                   wait_args;
112    uint32_t                   ticks;
113} rtems_monitor_task_t;
114
115/*
116 * Init task
117 */
118
119typedef struct {
120    rtems_id            id;             /* not really an id */
121    rtems_name          name;
122  /* end of common portion */
123    rtems_monitor_symbol_t entry;
124    uint32_t               argument;
125    uint32_t               stack_size;
126    rtems_task_priority    priority;
127    rtems_mode             modes;
128    rtems_attribute        attributes;
129} rtems_monitor_init_task_t;
130
131
132/*
133 * Message queue
134 */
135typedef struct {
136    rtems_id            id;
137    rtems_name          name;
138  /* end of common portion */
139    rtems_attribute     attributes;
140    uint32_t            number_of_pending_messages;
141    uint32_t            maximum_pending_messages;
142    size_t              maximum_message_size;
143} rtems_monitor_queue_t;
144
145/*
146 * Semaphore
147 */
148typedef struct {
149    rtems_id            id;
150    rtems_name          name;
151  /* end of common portion */
152    rtems_attribute     attribute;
153    rtems_task_priority priority_ceiling;
154    uint32_t            max_count;
155    uint32_t            cur_count;
156    rtems_id            holder_id;
157} rtems_monitor_sema_t;
158
159/*
160 * Extension
161 */
162typedef struct {
163    rtems_id                 id;
164    rtems_name               name;
165  /* end of common portion */
166    rtems_monitor_symbol_t  e_create;
167    rtems_monitor_symbol_t  e_start;
168    rtems_monitor_symbol_t  e_restart;
169    rtems_monitor_symbol_t  e_delete;
170    rtems_monitor_symbol_t  e_tswitch;
171    rtems_monitor_symbol_t  e_begin;
172    rtems_monitor_symbol_t  e_exitted;
173    rtems_monitor_symbol_t  e_fatal;
174} rtems_monitor_extension_t;
175
176 /*
177 * Region
178 */
179typedef struct {
180    rtems_id            id;
181    rtems_name          name;
182  /* end of common portion */
183  rtems_attribute     attribute;
184  void *              start_addr;
185  uint32_t            length;
186  uint32_t            page_size;
187  uint32_t            max_seg_size;
188  uint32_t            used_blocks;
189} rtems_monitor_region_t;
190
191/*
192 * Partition
193 */
194typedef struct {
195    rtems_id            id;
196    rtems_name          name;
197  /* end of common portion */
198  rtems_attribute     attribute;
199  void *              start_addr;
200  uint32_t            length;
201  uint32_t            buf_size;
202  uint32_t            used_blocks;
203} rtems_monitor_part_t;
204
205/*
206 * Device driver
207 */
208
209typedef struct {
210    rtems_id            id;                /* not really an id (should be tho) */
211    rtems_name          name;              /* ditto */
212  /* end of common portion */
213    rtems_monitor_symbol_t initialization; /* initialization procedure */
214    rtems_monitor_symbol_t open;           /* open request procedure */
215    rtems_monitor_symbol_t close;          /* close request procedure */
216    rtems_monitor_symbol_t read;           /* read request procedure */
217    rtems_monitor_symbol_t write;          /* write request procedure */
218    rtems_monitor_symbol_t control;        /* special functions procedure */
219} rtems_monitor_driver_t;
220
221/*
222 * System config
223 */
224
225typedef struct {
226    void               *work_space_start;
227    uint32_t            work_space_size;
228    uint32_t            maximum_tasks;
229    uint32_t            maximum_timers;
230    uint32_t            maximum_semaphores;
231    uint32_t            maximum_message_queues;
232    uint32_t            maximum_partitions;
233    uint32_t            maximum_regions;
234    uint32_t            maximum_ports;
235    uint32_t            maximum_periods;
236    uint32_t            maximum_extensions;
237    uint32_t            microseconds_per_tick;
238    uint32_t            ticks_per_timeslice;
239    uint32_t            number_of_initialization_tasks;
240} rtems_monitor_config_t;
241
242/*
243 * MPCI config
244 */
245
246#if defined(RTEMS_MULTIPROCESSING)
247typedef struct {
248    uint32_t    node;                   /* local node number */
249    uint32_t    maximum_nodes;          /* maximum # nodes in system */
250    uint32_t    maximum_global_objects; /* maximum # global objects */
251    uint32_t    maximum_proxies;        /* maximum # proxies */
252
253    uint32_t                 default_timeout;        /* in ticks */
254    size_t                   maximum_packet_size;
255    rtems_monitor_symbol_t   initialization;
256    rtems_monitor_symbol_t   get_packet;
257    rtems_monitor_symbol_t   return_packet;
258    rtems_monitor_symbol_t   send_packet;
259    rtems_monitor_symbol_t   receive_packet;
260} rtems_monitor_mpci_t;
261#endif
262
263/*
264 * The generic canonical information union
265 */
266
267typedef union {
268    rtems_monitor_generic_t    generic;
269    rtems_monitor_task_t       task;
270    rtems_monitor_queue_t      queue;
271    rtems_monitor_sema_t       sema;
272    rtems_monitor_extension_t  extension;
273    rtems_monitor_driver_t     driver;
274    rtems_monitor_config_t     config;
275    rtems_monitor_region_t     region;
276    rtems_monitor_part_t       part;
277#if defined(RTEMS_MULTIPROCESSING)
278    rtems_monitor_mpci_t       mpci;
279#endif
280    rtems_monitor_init_task_t  itask;
281} rtems_monitor_union_t;
282
283/*
284 * Support for talking to other monitors
285 */
286
287/*
288 * Names of other monitors
289 */
290
291#define RTEMS_MONITOR_NAME        (rtems_build_name('R', 'M', 'O', 'N'))
292#define RTEMS_MONITOR_SERVER_NAME (rtems_build_name('R', 'M', 'S', 'V'))
293#define RTEMS_MONITOR_QUEUE_NAME  (rtems_build_name('R', 'M', 'S', 'Q'))
294#define RTEMS_MONITOR_RESPONSE_QUEUE_NAME (rtems_build_name('R', 'M', 'R', 'Q'))
295
296#define RTEMS_MONITOR_SERVER_RESPONSE    0x0001
297#define RTEMS_MONITOR_SERVER_CANONICAL   0x0002
298
299typedef struct
300{
301    uint32_t    command;
302    rtems_id    return_id;
303    uint32_t    argument0;
304    uint32_t    argument1;
305    uint32_t    argument2;
306    uint32_t    argument3;
307    uint32_t    argument4;
308    uint32_t    argument5;
309} rtems_monitor_server_request_t;
310
311typedef struct
312{
313    uint32_t    command;
314    uint32_t    result0;
315    uint32_t    result1;
316    rtems_monitor_union_t payload;
317} rtems_monitor_server_response_t;
318
319extern rtems_id  rtems_monitor_task_id;
320
321extern uint32_t   rtems_monitor_node;          /* our node number */
322extern uint32_t   rtems_monitor_default_node;  /* current default for commands */
323
324/*
325 * Monitor command function and table entry
326 */
327
328typedef struct rtems_monitor_command_entry_s rtems_monitor_command_entry_t;
329typedef union _rtems_monitor_command_arg_t   rtems_monitor_command_arg_t;
330
331typedef void (*rtems_monitor_command_function_t)(
332  int                                argc,
333  char                             **argv,
334  const rtems_monitor_command_arg_t *command_arg,
335  bool                               verbose
336);
337
338union _rtems_monitor_command_arg_t {
339  rtems_monitor_object_type_t   monitor_object;
340  rtems_status_code             status_code;
341  rtems_symbol_table_t          **symbol_table;
342  const rtems_monitor_command_entry_t *monitor_command_entry;
343};
344
345struct rtems_monitor_command_entry_s {
346    const char *command;      /* command name */
347    const char *usage;        /* usage string for the command */
348    uint32_t arguments_required;    /* # of required args */
349    rtems_monitor_command_function_t command_function;
350                               /* Some argument for the command */
351    rtems_monitor_command_arg_t command_arg;
352    const rtems_monitor_command_entry_t *next;
353};
354
355
356typedef void *(*rtems_monitor_object_next_fn)(void *, void *, rtems_id *);
357typedef void (*rtems_monitor_object_canonical_fn)(void *, void *);
358typedef void (*rtems_monitor_object_dump_header_fn)(bool);
359typedef void (*rtems_monitor_object_dump_fn)(void *, bool);
360
361typedef struct {
362    rtems_monitor_object_type_t         type;
363    void                               *object_information;
364    int                                 size;   /* of canonical object */
365    rtems_monitor_object_next_fn        next;
366    rtems_monitor_object_canonical_fn   canonical;
367    rtems_monitor_object_dump_header_fn dump_header;
368    rtems_monitor_object_dump_fn        dump;
369} rtems_monitor_object_info_t;
370
371typedef bool (*rtems_monitor_per_command_routine)(const rtems_monitor_command_entry_t *, void *);
372
373/* monitor.c */
374void    rtems_monitor_pause_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
375void    rtems_monitor_fatal_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
376void    rtems_monitor_continue_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
377void    rtems_monitor_debugger_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
378void    rtems_monitor_reset_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
379void    rtems_monitor_node_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
380void    rtems_monitor_symbols_loadup(void);
381int     rtems_monitor_insert_cmd(rtems_monitor_command_entry_t *);
382void    rtems_monitor_wakeup(void);
383void rtems_monitor_command_iterate(rtems_monitor_per_command_routine routine, void *arg);
384rtems_status_code rtems_monitor_suspend(rtems_interval timeout);
385
386/* editor.c */
387void    rtems_monitor_kill(void);
388void    rtems_monitor_init(uint32_t);
389void    rtems_monitor_task(rtems_task_argument);
390
391/* server.c */
392void    rtems_monitor_server_kill(void);
393rtems_status_code rtems_monitor_server_request(uint32_t  , rtems_monitor_server_request_t *, rtems_monitor_server_response_t *);
394void    rtems_monitor_server_task(rtems_task_argument);
395void    rtems_monitor_server_init(uint32_t  );
396
397/* command.c */
398int     rtems_monitor_make_argv(char *, int *, char **);
399int     rtems_monitor_command_read(char *, int *, char **);
400void    rtems_monitor_command_usage(const rtems_monitor_command_entry_t *, const char *);
401void    rtems_monitor_help_cmd(int, char **, const rtems_monitor_command_arg_t *, bool);
402const rtems_monitor_command_entry_t *rtems_monitor_command_lookup(const char *name);
403
404/* prmisc.c */
405void       rtems_monitor_separator(void);
406uint32_t   rtems_monitor_pad(uint32_t   dest_col, uint32_t   curr_col);
407int        rtems_monitor_dump_decimal(uint32_t   num);
408int        rtems_monitor_dump_hex(uint32_t   num);
409int        rtems_monitor_dump_addr(void *addr);
410int        rtems_monitor_dump_id(rtems_id id);
411int        rtems_monitor_dump_name(rtems_id id);
412int        rtems_monitor_dump_priority(rtems_task_priority priority);
413int        rtems_monitor_dump_state(States_Control state);
414int        rtems_monitor_dump_modes(rtems_mode modes);
415int        rtems_monitor_dump_attributes(rtems_attribute attributes);
416int        rtems_monitor_dump_events(rtems_event_set events);
417int        rtems_monitor_dump_notepad(uint32_t   *notepad);
418
419/* object.c */
420rtems_id   rtems_monitor_id_fixup(rtems_id, uint32_t  , rtems_monitor_object_type_t);
421const rtems_monitor_object_info_t *rtems_monitor_object_lookup(rtems_monitor_object_type_t type);
422rtems_id   rtems_monitor_object_canonical_get(rtems_monitor_object_type_t, rtems_id, void *, size_t *size_p);
423rtems_id   rtems_monitor_object_canonical_next(const rtems_monitor_object_info_t *, rtems_id, void *);
424void      *rtems_monitor_object_next(void *, void *, rtems_id, rtems_id *);
425rtems_id   rtems_monitor_object_canonical(rtems_id, void *);
426void       rtems_monitor_object_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
427
428/* manager.c */
429void      *rtems_monitor_manager_next(void *, void *, rtems_id *);
430
431/* config.c */
432void       rtems_monitor_config_canonical(rtems_monitor_config_t *, void *);
433void      *rtems_monitor_config_next(void *, rtems_monitor_config_t *, rtems_id *);
434void       rtems_monitor_config_dump_header(bool);
435int        rtems_monitor_config_dump(rtems_monitor_config_t *, bool verbose);
436
437/* mpci.c */
438#if defined(RTEMS_MULTIPROCESSING)
439void       rtems_monitor_mpci_canonical(rtems_monitor_mpci_t *, void *);
440void      *rtems_monitor_mpci_next(void *, rtems_monitor_mpci_t *, rtems_id *);
441void       rtems_monitor_mpci_dump_header(bool);
442void       rtems_monitor_mpci_dump(rtems_monitor_mpci_t *, bool verbose);
443#endif
444
445/* itask.c */
446void       rtems_monitor_init_task_canonical(rtems_monitor_init_task_t *, void *);
447void      *rtems_monitor_init_task_next(void *, rtems_monitor_init_task_t *, rtems_id *);
448void       rtems_monitor_init_task_dump_header(bool);
449void       rtems_monitor_init_task_dump(rtems_monitor_init_task_t *, bool verbose);
450
451/* extension.c */
452void       rtems_monitor_extension_canonical(rtems_monitor_extension_t *, void *);
453void       rtems_monitor_extension_dump_header(bool verbose);
454void       rtems_monitor_extension_dump(rtems_monitor_extension_t *, bool);
455
456/* task.c */
457void    rtems_monitor_task_canonical(rtems_monitor_task_t *, void *);
458void    rtems_monitor_task_dump_header(bool verbose);
459void    rtems_monitor_task_dump(rtems_monitor_task_t *, bool);
460
461/* sema.c */
462void    rtems_monitor_sema_canonical(rtems_monitor_sema_t *, void *);
463void    rtems_monitor_sema_dump_header(bool verbose);
464void    rtems_monitor_sema_dump(rtems_monitor_sema_t *, bool);
465
466/* queue.c */
467void    rtems_monitor_queue_canonical(rtems_monitor_queue_t *, void *);
468void    rtems_monitor_queue_dump_header(bool verbose);
469void    rtems_monitor_queue_dump(rtems_monitor_queue_t *, bool);
470
471/* region.c */
472void    rtems_monitor_region_canonical(rtems_monitor_region_t *, void *);
473void    rtems_monitor_region_dump_header(bool verbose);
474void    rtems_monitor_region_dump(rtems_monitor_region_t *, bool);
475
476/* partition.c */
477void    rtems_monitor_part_canonical(rtems_monitor_part_t *, void *);
478void    rtems_monitor_part_dump_header(bool verbose);
479void    rtems_monitor_part_dump(rtems_monitor_part_t *, bool);
480
481/* driver.c */
482void    *rtems_monitor_driver_next(void *, rtems_monitor_driver_t *, rtems_id *);
483void     rtems_monitor_driver_canonical(rtems_monitor_driver_t *, void *);
484void     rtems_monitor_driver_dump_header(bool);
485void     rtems_monitor_driver_dump(rtems_monitor_driver_t *, bool);
486
487/* symbols.c */
488rtems_symbol_table_t *rtems_symbol_table_create(void);
489void                  rtems_symbol_table_destroy(rtems_symbol_table_t *table);
490
491rtems_symbol_t *rtems_symbol_create(rtems_symbol_table_t *, const char *, uint32_t  );
492rtems_symbol_t *rtems_symbol_value_lookup(rtems_symbol_table_t *, uint32_t  );
493const rtems_symbol_t *rtems_symbol_value_lookup_exact(rtems_symbol_table_t *, uint32_t  );
494rtems_symbol_t *rtems_symbol_name_lookup(rtems_symbol_table_t *, const char *);
495void   *rtems_monitor_symbol_next(void *object_info, rtems_monitor_symbol_t *, rtems_id *);
496void    rtems_monitor_symbol_canonical(rtems_monitor_symbol_t *, rtems_symbol_t *);
497void    rtems_monitor_symbol_canonical_by_name(rtems_monitor_symbol_t *, const char *);
498void    rtems_monitor_symbol_canonical_by_value(rtems_monitor_symbol_t *, void *);
499uint32_t   rtems_monitor_symbol_dump(rtems_monitor_symbol_t *, bool);
500void    rtems_monitor_symbol_cmd(int, char **, const rtems_monitor_command_arg_t*, bool);
501
502#if defined(RTEMS_NETWORKING)
503void mon_ifconfig(
504  int argc,
505  char *argv[],
506  uint32_t command_arg,
507  bool verbose
508);
509void mon_route(
510  int argc,
511  char *argv[],
512  uint32_t command_arg,
513  bool verbose
514);
515#endif
516
517/* mon-object.c */
518const rtems_monitor_object_info_t *rtems_monitor_object_lookup(
519  rtems_monitor_object_type_t type
520);
521
522/* shared data */
523extern rtems_symbol_table_t *rtems_monitor_symbols;
524
525#define MONITOR_WAKEUP_EVENT   RTEMS_EVENT_0
526
527#ifdef __cplusplus
528}
529#endif
530
531#endif  /* ! __MONITOR_H */
Note: See TracBrowser for help on using the repository browser.