annotate packages/hal/common/current/include/dbg-threads-api.h @ 1777:c16341b1bac6 default tip

* Added execute permissions to files missed in conversion from CVS
author alexs
date Mon, 12 Oct 2009 02:26:09 +0100
parents d2c90368aeef
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
1 //========================================================================
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
2 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
3 // dbg-threads-api.h
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
4 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
5 // Supports thread-aware debugging
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
6 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
7 //========================================================================
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
8 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
9 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
10 // This file is part of eCos, the Embedded Configurable Operating System.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
12 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
13 // eCos is free software; you can redistribute it and/or modify it under
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
14 // the terms of the GNU General Public License as published by the Free
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
15 // Software Foundation; either version 2 or (at your option) any later version.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
16 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
19 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
20 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
21 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
22 // You should have received a copy of the GNU General Public License along
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
23 // with eCos; if not, write to the Free Software Foundation, Inc.,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
25 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
26 // As a special exception, if other files instantiate templates or use macros
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
27 // or inline functions from this file, or you compile this file and link it
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
28 // with other works to produce a work based on this file, this file does not
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
29 // by itself cause the resulting work to be covered by the GNU General Public
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
30 // License. However the source code for this file must still be made available
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
31 // in accordance with section (3) of the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
32 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
33 // This exception does not invalidate any other reasons why a work based on
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
34 // this file might be covered by the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
35 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
210
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
37 // at http://sources.redhat.com/ecos/ecos-license/
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
38 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 156
diff changeset
39 //####ECOSGPLCOPYRIGHTEND####
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
40 //========================================================================
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
41 //#####DESCRIPTIONBEGIN####
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
42 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
43 // Author(s): Red Hat, nickg
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
44 // Contributors: Red Hat, nickg
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
45 // Date: 1998-08-25
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
46 // Purpose:
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
47 // Description: These are the calls used to extract operating system
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
48 // specific information used in supporting thread aware
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
49 // debugging. The Operating Environment being debugged
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
50 // needs to supply these functions.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
51 // Usage: This header is not to be included by user code.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
52 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
53 //####DESCRIPTIONEND####
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
54 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
55 //========================================================================
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 54
diff changeset
56
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
57 #if !defined(DBG_THREADS_API_INCLUDED)
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
58 #define DBG_THREADS_API_INCLUDED 1
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
59
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
60 #include <cyg/infra/cyg_type.h> /* externC */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
61
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
62 #define has_thread_void 0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
63 #define has_thread_current 1
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
64 #define has_thread_registers 2
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
65 #define has_thread_reg_change 4
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
66 #define has_thread_list 8
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
67 #define has_thread_info 16
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
68
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
69 typedef unsigned char threadref[8] ;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
70
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
71 struct dbg_capabilities
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
72 {
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
73 unsigned long mask1 ;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
74 } ;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
75
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
76
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
77 /* fill in the list of thread aware capabilities */
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
78 externC int dbg_thread_capabilities(struct dbg_capabilities * cbp) ;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
79
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
80
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
81 /* Fillin the identifier of the current thread */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
82 /* return 1 if defined, 0 if not defined */
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
83 externC int dbg_currthread(threadref * varparm) ;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
84
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents: 105
diff changeset
85 /* Return the unique ID number of a given thread. */
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents: 105
diff changeset
86 /* Return 0 if not valid. */
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents: 105
diff changeset
87 externC int dbg_thread_id(threadref *threadid);
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents: 105
diff changeset
88
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
89 /* Return the unique ID number of the current thread. */
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
90 externC int dbg_currthread_id(void);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
91
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
92 /* get the first or next member of the list of known threads */
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
93 externC int dbg_threadlist(int startflag,
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
94 threadref * lastthreadid,
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
95 threadref * next_thread
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
96 ) ;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
97
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
98 /* return 1 if next_threadid has been filled in with a value */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
99 /* return 0 if there are none or no more */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
100
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
101 /* The O.S can fill in the following information about a thread when queried.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
102 The structure of thise strings is determined by the O.S.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
103 It is display oriented, so figure out what the users need to see.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
104 Nulls are OK but GDB will fill some not so meaningful data.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
105 These pointers may be in the calles private structures, the info will
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
106 get copied immediatly after the call to retreive it.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
107 */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
108 struct cygmon_thread_debug_info
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
109 {
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
110 threadref thread_id ;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
111 int context_exists ; /* To the point where examining its state,
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
112 registers and stack makes sense to GDB */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
113 char * thread_display ; /* As shown in thread status window, name, state */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
114 char * unique_thread_name ; /* human readable identifier, window label */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
115 char * more_display ; /* more detailed info about thread.
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
116 priority, queuedepth, state, stack usage, statistics */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
117 } ;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
118
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
119
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
120
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
121
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
122 externC int dbg_threadinfo(
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
123 threadref * threadid,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
124 struct cygmon_thread_debug_info * info) ;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
125
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
126 /* Return 1 if threadid is defined and info copied, 0 otherwise */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
127
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
128 /* The O.S should fillin the array of registers using values from the
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
129 saves context. The array MUST be in GDB register save order even if
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
130 the saved context is different or smaller. Do not alter the values of
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
131 registers which are NOT in the O.S. thread context. Their default values
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
132 have already been assigned.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
133 */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
134
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
135 externC int dbg_getthreadreg(
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
136 threadref * osthreadid,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
137 int regcount, /* count of registers in the array */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
138 void * regval) ; /* fillin this array */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
139
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
140
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
141 /* The O.S. should scan through this list of registers which are in
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
142 GDB order and the O.S. should replace the values of all registers
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
143 which are defined in the saved context of thread or process identified
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
144 by osthreadid. Return 0 if the threadis does not map to a known
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
145 process or other error. Return 1 if the setting is successful. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
146
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 66
diff changeset
147 externC int dbg_setthreadreg(
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
148 threadref * osthreadid,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
149 int regcount , /* number of registers */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
150 void * regval) ;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
151
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
152 /* Control over OS scheduler. With the scheduler locked it should not
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
153 perform any rescheduling in response to interrupts. */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
154 externC int dbg_scheduler(
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
155 threadref * osthreadid,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
156 int lock, /* 0 == unlock, 1 == lock */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
157 int mode); /* 0 == step, 1 == continue */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
158
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
159
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
160
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
161 #endif /* DBG_THREADS_API_INCLUDED */