Commit | Line | Data |
---|---|---|
574dd9a9 MK |
1 | #ifdef HAVE_THREAD_DB_H |
2 | #include <thread_db.h> | |
17a37d48 PP |
3 | |
4 | #ifndef LIBTHREAD_DB_SO | |
5 | #define LIBTHREAD_DB_SO "libthread_db.so.1" | |
6 | #endif | |
7 | ||
8 | #ifndef LIBTHREAD_DB_SEARCH_PATH | |
9 | #define LIBTHREAD_DB_SEARCH_PATH "" | |
10 | #endif | |
11 | ||
574dd9a9 MK |
12 | #else |
13 | ||
4c38e0a4 JB |
14 | /* Copyright (C) 1999, 2000, 2007, 2008, 2009, 2010 |
15 | Free Software Foundation, Inc. | |
ed9a39eb JM |
16 | This file is part of the GNU C Library. |
17 | ||
18 | The GNU C Library is free software; you can redistribute it and/or | |
19 | modify it under the terms of the GNU Library General Public License as | |
5b1ba0e5 | 20 | published by the Free Software Foundation; either version 3 of the |
ed9a39eb JM |
21 | License, or (at your option) any later version. |
22 | ||
23 | The GNU C Library is distributed in the hope that it will be useful, | |
24 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 | Library General Public License for more details. | |
27 | ||
5b1ba0e5 NS |
28 | You should have received a copy of the GNU General Public License |
29 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
ed9a39eb JM |
30 | |
31 | #ifndef _THREAD_DB_H | |
32 | #define _THREAD_DB_H 1 | |
33 | ||
34 | /* This is the debugger interface for the LinuxThreads library. It is | |
35 | modelled closely after the interface with same names in Solaris with | |
36 | the goal to share the same code in the debugger. */ | |
37 | #include <pthread.h> | |
ed9a39eb | 38 | #include <sys/types.h> |
574dd9a9 | 39 | #include <sys/procfs.h> |
ed9a39eb JM |
40 | |
41 | ||
42 | /* Error codes of the library. */ | |
43 | typedef enum | |
44 | { | |
574dd9a9 MK |
45 | TD_OK, /* No error. */ |
46 | TD_ERR, /* No further specified error. */ | |
47 | TD_NOTHR, /* No matching thread found. */ | |
48 | TD_NOSV, /* No matching synchronization handle found. */ | |
49 | TD_NOLWP, /* No matching light-weighted process found. */ | |
50 | TD_BADPH, /* Invalid process handle. */ | |
51 | TD_BADTH, /* Invalid thread handle. */ | |
52 | TD_BADSH, /* Invalid synchronization handle. */ | |
53 | TD_BADTA, /* Invalid thread agent. */ | |
54 | TD_BADKEY, /* Invalid key. */ | |
55 | TD_NOMSG, /* No event available. */ | |
56 | TD_NOFPREGS, /* No floating-point register content available. */ | |
57 | TD_NOLIBTHREAD, /* Application not linked with thread library. */ | |
58 | TD_NOEVENT, /* Requested event is not supported. */ | |
59 | TD_NOCAPAB, /* Capability not available. */ | |
60 | TD_DBERR, /* Internal debug library error. */ | |
61 | TD_NOAPLIC, /* Operation is not applicable. */ | |
62 | TD_NOTSD, /* No thread-specific data available. */ | |
63 | TD_MALLOC, /* Out of memory. */ | |
64 | TD_PARTIALREG, /* Not entire register set was read or written. */ | |
3f47be5c EZ |
65 | TD_NOXREGS, /* X register set not available for given thread. */ |
66 | TD_NOTALLOC /* TLS memory not yet allocated. */ | |
ed9a39eb JM |
67 | } td_err_e; |
68 | ||
69 | ||
70 | /* Possible thread states. TD_THR_ANY_STATE is a pseudo-state used to | |
71 | select threads regardless of state in td_ta_thr_iter(). */ | |
72 | typedef enum | |
73 | { | |
74 | TD_THR_ANY_STATE, | |
75 | TD_THR_UNKNOWN, | |
76 | TD_THR_STOPPED, | |
77 | TD_THR_RUN, | |
78 | TD_THR_ACTIVE, | |
79 | TD_THR_ZOMBIE, | |
80 | TD_THR_SLEEP, | |
81 | TD_THR_STOPPED_ASLEEP | |
82 | } td_thr_state_e; | |
83 | ||
84 | /* Thread type: user or system. TD_THR_ANY_TYPE is a pseudo-type used | |
85 | to select threads regardless of type in td_ta_thr_iter(). */ | |
86 | typedef enum | |
87 | { | |
88 | TD_THR_ANY_TYPE, | |
89 | TD_THR_USER, | |
90 | TD_THR_SYSTEM | |
91 | } td_thr_type_e; | |
92 | ||
93 | ||
94 | /* Types of the debugging library. */ | |
95 | ||
ed9a39eb JM |
96 | /* Handle for a process. This type is opaque. */ |
97 | typedef struct td_thragent td_thragent_t; | |
98 | ||
99 | /* The actual thread handle type. This is also opaque. */ | |
100 | typedef struct td_thrhandle | |
101 | { | |
102 | td_thragent_t *th_ta_p; | |
103 | psaddr_t th_unique; | |
104 | } td_thrhandle_t; | |
105 | ||
106 | ||
107 | /* Flags for `td_ta_thr_iter'. */ | |
108 | #define TD_THR_ANY_USER_FLAGS 0xffffffff | |
109 | #define TD_THR_LOWEST_PRIORITY -20 | |
110 | #define TD_SIGNO_MASK NULL | |
111 | ||
112 | ||
113 | #define TD_EVENTSIZE 2 | |
114 | #define BT_UISHIFT 5 /* log base 2 of BT_NBIPUI, to extract word index */ | |
115 | #define BT_NBIPUI (1 << BT_UISHIFT) /* n bits per uint */ | |
116 | #define BT_UIMASK (BT_NBIPUI - 1) /* to extract bit index */ | |
117 | ||
118 | /* Bitmask of enabled events. */ | |
119 | typedef struct td_thr_events | |
120 | { | |
d5af19ba | 121 | uint32_t event_bits[TD_EVENTSIZE]; |
ed9a39eb JM |
122 | } td_thr_events_t; |
123 | ||
124 | /* Event set manipulation macros. */ | |
125 | #define __td_eventmask(n) \ | |
d5af19ba | 126 | (UINT32_C (1) << (((n) - 1) & BT_UIMASK)) |
ed9a39eb | 127 | #define __td_eventword(n) \ |
d5af19ba | 128 | ((UINT32_C ((n) - 1)) >> BT_UISHIFT) |
ed9a39eb JM |
129 | |
130 | #define td_event_emptyset(setp) \ | |
131 | do { \ | |
132 | int __i; \ | |
133 | for (__i = TD_EVENTSIZE; __i > 0; --__i) \ | |
134 | (setp)->event_bits[__i - 1] = 0; \ | |
135 | } while (0) | |
136 | ||
137 | #define td_event_fillset(setp) \ | |
138 | do { \ | |
139 | int __i; \ | |
140 | for (__i = TD_EVENTSIZE; __i > 0; --__i) \ | |
d5af19ba | 141 | (setp)->event_bits[__i - 1] = UINT32_C (0xffffffff); \ |
ed9a39eb JM |
142 | } while (0) |
143 | ||
144 | #define td_event_addset(setp, n) \ | |
145 | (((setp)->event_bits[__td_eventword (n)]) |= __td_eventmask (n)) | |
146 | #define td_event_delset(setp, n) \ | |
147 | (((setp)->event_bits[__td_eventword (n)]) &= ~__td_eventmask (n)) | |
148 | #define td_eventismember(setp, n) \ | |
149 | (__td_eventmask (n) & ((setp)->event_bits[__td_eventword (n)])) | |
150 | #if TD_EVENTSIZE == 2 | |
151 | # define td_eventisempty(setp) \ | |
152 | (!((setp)->event_bits[0]) && !((setp)->event_bits[1])) | |
153 | #else | |
154 | # error "td_eventisempty must be changed to match TD_EVENTSIZE" | |
155 | #endif | |
156 | ||
157 | /* Events reportable by the thread implementation. */ | |
158 | typedef enum | |
159 | { | |
160 | TD_ALL_EVENTS, /* Pseudo-event number. */ | |
161 | TD_EVENT_NONE = TD_ALL_EVENTS, /* Depends on context. */ | |
162 | TD_READY, /* Is executable now. */ | |
163 | TD_SLEEP, /* Blocked in a synchronization obj. */ | |
164 | TD_SWITCHTO, /* Now assigned to a process. */ | |
165 | TD_SWITCHFROM, /* Not anymore assigned to a process. */ | |
166 | TD_LOCK_TRY, /* Trying to get an unavailable lock. */ | |
167 | TD_CATCHSIG, /* Signal posted to the thread. */ | |
168 | TD_IDLE, /* Process getting idle. */ | |
169 | TD_CREATE, /* New thread created. */ | |
170 | TD_DEATH, /* Thread terminated. */ | |
171 | TD_PREEMPT, /* Preempted. */ | |
172 | TD_PRI_INHERIT, /* Inherited elevated priority. */ | |
173 | TD_REAP, /* Reaped. */ | |
174 | TD_CONCURRENCY, /* Number of processes changing. */ | |
175 | TD_TIMEOUT, /* Conditional variable wait timed out. */ | |
176 | TD_MIN_EVENT_NUM = TD_READY, | |
177 | TD_MAX_EVENT_NUM = TD_TIMEOUT, | |
178 | TD_EVENTS_ENABLE = 31 /* Event reporting enabled. */ | |
179 | } td_event_e; | |
180 | ||
181 | /* Values representing the different ways events are reported. */ | |
182 | typedef enum | |
183 | { | |
184 | NOTIFY_BPT, /* User must insert breakpoint at u.bptaddr. */ | |
185 | NOTIFY_AUTOBPT, /* Breakpoint at u.bptaddr is automatically | |
186 | inserted. */ | |
187 | NOTIFY_SYSCALL /* System call u.syscallno will be invoked. */ | |
188 | } td_notify_e; | |
189 | ||
190 | /* Description how event type is reported. */ | |
191 | typedef struct td_notify | |
192 | { | |
193 | td_notify_e type; /* Way the event is reported. */ | |
194 | union | |
195 | { | |
196 | psaddr_t bptaddr; /* Address of breakpoint. */ | |
197 | int syscallno; /* Number of system call used. */ | |
198 | } u; | |
199 | } td_notify_t; | |
200 | ||
18972eea MC |
201 | /* Some people still have libc5 or old glibc with no uintptr_t. |
202 | They lose. glibc 2.1.3 was released on 2000-02-25, and it has | |
203 | uintptr_t, so it's reasonable to force these people to upgrade. */ | |
204 | ||
205 | #ifndef HAVE_UINTPTR_T | |
206 | #error No uintptr_t available; your C library is too old. | |
207 | /* Inhibit further compilation errors after this error. */ | |
208 | #define uintptr_t void * | |
209 | #endif | |
210 | ||
ed9a39eb JM |
211 | /* Structure used to report event. */ |
212 | typedef struct td_event_msg | |
213 | { | |
214 | td_event_e event; /* Event type being reported. */ | |
215 | const td_thrhandle_t *th_p; /* Thread reporting the event. */ | |
216 | union | |
217 | { | |
574dd9a9 | 218 | #if 0 |
ed9a39eb JM |
219 | td_synchandle_t *sh; /* Handle of synchronization object. */ |
220 | #endif | |
221 | uintptr_t data; /* Event specific data. */ | |
222 | } msg; | |
223 | } td_event_msg_t; | |
224 | ||
574dd9a9 MK |
225 | /* Structure containing event data available in each thread structure. */ |
226 | typedef struct | |
227 | { | |
228 | td_thr_events_t eventmask; /* Mask of enabled events. */ | |
229 | td_event_e eventnum; /* Number of last event. */ | |
230 | void *eventdata; /* Data associated with event. */ | |
231 | } td_eventbuf_t; | |
232 | ||
ed9a39eb JM |
233 | |
234 | /* Gathered statistics about the process. */ | |
235 | typedef struct td_ta_stats | |
236 | { | |
237 | int nthreads; /* Total number of threads in use. */ | |
238 | int r_concurrency; /* Concurrency level requested by user. */ | |
239 | int nrunnable_num; /* Average runnable threads, numerator. */ | |
240 | int nrunnable_den; /* Average runnable threads, denominator. */ | |
241 | int a_concurrency_num; /* Achieved concurrency level, numerator. */ | |
242 | int a_concurrency_den; /* Achieved concurrency level, denominator. */ | |
243 | int nlwps_num; /* Average number of processes in use, | |
244 | numerator. */ | |
245 | int nlwps_den; /* Average number of processes in use, | |
246 | denominator. */ | |
247 | int nidle_num; /* Average number of idling processes, | |
248 | numerator. */ | |
249 | int nidle_den; /* Average number of idling processes, | |
250 | denominator. */ | |
251 | } td_ta_stats_t; | |
252 | ||
253 | ||
254 | /* Since Sun's library is based on Solaris threads we have to define a few | |
255 | types to map them to POSIX threads. */ | |
256 | typedef pthread_t thread_t; | |
257 | typedef pthread_key_t thread_key_t; | |
258 | ||
ed9a39eb JM |
259 | |
260 | /* Callback for iteration over threads. */ | |
574dd9a9 | 261 | typedef int td_thr_iter_f (const td_thrhandle_t *, void *); |
ed9a39eb JM |
262 | |
263 | /* Callback for iteration over thread local data. */ | |
574dd9a9 | 264 | typedef int td_key_iter_f (thread_key_t, void (*) (void *), void *); |
ed9a39eb JM |
265 | |
266 | ||
267 | ||
268 | /* Forward declaration. This has to be defined by the user. */ | |
269 | struct ps_prochandle; | |
270 | ||
ed9a39eb JM |
271 | |
272 | /* Information about the thread. */ | |
273 | typedef struct td_thrinfo | |
274 | { | |
275 | td_thragent_t *ti_ta_p; /* Process handle. */ | |
276 | unsigned int ti_user_flags; /* Unused. */ | |
277 | thread_t ti_tid; /* Thread ID returned by | |
278 | pthread_create(). */ | |
279 | char *ti_tls; /* Pointer to thread-local data. */ | |
280 | psaddr_t ti_startfunc; /* Start function passed to | |
281 | pthread_create(). */ | |
282 | psaddr_t ti_stkbase; /* Base of thread's stack. */ | |
283 | long int ti_stksize; /* Size of thread's stack. */ | |
284 | psaddr_t ti_ro_area; /* Unused. */ | |
285 | int ti_ro_size; /* Unused. */ | |
286 | td_thr_state_e ti_state; /* Thread state. */ | |
287 | unsigned char ti_db_suspended; /* Nonzero if suspended by debugger. */ | |
288 | td_thr_type_e ti_type; /* Type of the thread (system vs | |
289 | user thread). */ | |
290 | intptr_t ti_pc; /* Unused. */ | |
291 | intptr_t ti_sp; /* Unused. */ | |
292 | short int ti_flags; /* Unused. */ | |
293 | int ti_pri; /* Thread priority. */ | |
04c663e3 | 294 | lwpid_t ti_lid; /* Kernel pid for this thread. */ |
ed9a39eb JM |
295 | sigset_t ti_sigmask; /* Signal mask. */ |
296 | unsigned char ti_traceme; /* Nonzero if event reporting | |
297 | enabled. */ | |
298 | unsigned char ti_preemptflag; /* Unused. */ | |
299 | unsigned char ti_pirecflag; /* Unused. */ | |
300 | sigset_t ti_pending; /* Set of pending signals. */ | |
301 | td_thr_events_t ti_events; /* Set of enabled events. */ | |
302 | } td_thrinfo_t; | |
303 | ||
304 | ||
305 | ||
306 | /* Prototypes for exported library functions. */ | |
307 | ||
308 | /* Initialize the thread debug support library. */ | |
309 | extern td_err_e td_init (void); | |
310 | ||
311 | /* Historical relict. Should not be used anymore. */ | |
312 | extern td_err_e td_log (void); | |
313 | ||
314 | /* Generate new thread debug library handle for process PS. */ | |
315 | extern td_err_e td_ta_new (struct ps_prochandle *__ps, td_thragent_t **__ta); | |
316 | ||
317 | /* Free resources allocated for TA. */ | |
318 | extern td_err_e td_ta_delete (td_thragent_t *__ta); | |
319 | ||
320 | /* Get number of currently running threads in process associated with TA. */ | |
321 | extern td_err_e td_ta_get_nthreads (const td_thragent_t *__ta, int *__np); | |
322 | ||
323 | /* Return process handle passed in `td_ta_new' for process associated with | |
324 | TA. */ | |
325 | extern td_err_e td_ta_get_ph (const td_thragent_t *__ta, | |
326 | struct ps_prochandle **__ph); | |
327 | ||
328 | /* Map thread library handle PT to thread debug library handle for process | |
329 | associated with TA and store result in *TH. */ | |
330 | extern td_err_e td_ta_map_id2thr (const td_thragent_t *__ta, pthread_t __pt, | |
331 | td_thrhandle_t *__th); | |
332 | ||
333 | /* Map process ID LWPID to thread debug library handle for process | |
334 | associated with TA and store result in *TH. */ | |
335 | extern td_err_e td_ta_map_lwp2thr (const td_thragent_t *__ta, lwpid_t __lwpid, | |
336 | td_thrhandle_t *__th); | |
337 | ||
338 | ||
339 | /* Call for each thread in a process associated with TA the callback function | |
340 | CALLBACK. */ | |
341 | extern td_err_e td_ta_thr_iter (const td_thragent_t *__ta, | |
342 | td_thr_iter_f *__callback, void *__cbdata_p, | |
343 | td_thr_state_e __state, int __ti_pri, | |
344 | sigset_t *__ti_sigmask_p, | |
345 | unsigned int __ti_user_flags); | |
346 | ||
347 | /* Call for each defined thread local data entry the callback function KI. */ | |
348 | extern td_err_e td_ta_tsd_iter (const td_thragent_t *__ta, td_key_iter_f *__ki, | |
349 | void *__p); | |
350 | ||
351 | ||
352 | /* Get event address for EVENT. */ | |
353 | extern td_err_e td_ta_event_addr (const td_thragent_t *__ta, | |
354 | td_event_e __event, td_notify_t *__ptr); | |
355 | ||
574dd9a9 MK |
356 | /* Enable EVENT in global mask. */ |
357 | extern td_err_e td_ta_set_event (const td_thragent_t *__ta, | |
358 | td_thr_events_t *__event); | |
359 | ||
360 | /* Disable EVENT in global mask. */ | |
361 | extern td_err_e td_ta_clear_event (const td_thragent_t *__ta, | |
362 | td_thr_events_t *__event); | |
363 | ||
364 | /* Return information about last event. */ | |
365 | extern td_err_e td_ta_event_getmsg (const td_thragent_t *__ta, | |
366 | td_event_msg_t *msg); | |
367 | ||
ed9a39eb JM |
368 | |
369 | /* Set suggested concurrency level for process associated with TA. */ | |
370 | extern td_err_e td_ta_setconcurrency (const td_thragent_t *__ta, int __level); | |
371 | ||
372 | ||
373 | /* Enable collecting statistics for process associated with TA. */ | |
374 | extern td_err_e td_ta_enable_stats (const td_thragent_t *__ta, int __enable); | |
375 | ||
376 | /* Reset statistics. */ | |
377 | extern td_err_e td_ta_reset_stats (const td_thragent_t *__ta); | |
378 | ||
379 | /* Retrieve statistics from process associated with TA. */ | |
380 | extern td_err_e td_ta_get_stats (const td_thragent_t *__ta, | |
381 | td_ta_stats_t *__statsp); | |
382 | ||
383 | ||
384 | /* Validate that TH is a thread handle. */ | |
385 | extern td_err_e td_thr_validate (const td_thrhandle_t *__th); | |
386 | ||
387 | /* Return information about thread TH. */ | |
388 | extern td_err_e td_thr_get_info (const td_thrhandle_t *__th, | |
389 | td_thrinfo_t *__infop); | |
390 | ||
391 | /* Retrieve floating-point register contents of process running thread TH. */ | |
392 | extern td_err_e td_thr_getfpregs (const td_thrhandle_t *__th, | |
393 | prfpregset_t *__regset); | |
394 | ||
395 | /* Retrieve general register contents of process running thread TH. */ | |
396 | extern td_err_e td_thr_getgregs (const td_thrhandle_t *__th, | |
397 | prgregset_t __gregs); | |
398 | ||
399 | /* Retrieve extended register contents of process running thread TH. */ | |
400 | extern td_err_e td_thr_getxregs (const td_thrhandle_t *__th, void *__xregs); | |
401 | ||
402 | /* Get size of extended register set of process running thread TH. */ | |
403 | extern td_err_e td_thr_getxregsize (const td_thrhandle_t *__th, int *__sizep); | |
404 | ||
405 | /* Set floating-point register contents of process running thread TH. */ | |
406 | extern td_err_e td_thr_setfpregs (const td_thrhandle_t *__th, | |
407 | const prfpregset_t *__fpregs); | |
408 | ||
409 | /* Set general register contents of process running thread TH. */ | |
410 | extern td_err_e td_thr_setgregs (const td_thrhandle_t *__th, | |
411 | prgregset_t __gregs); | |
412 | ||
413 | /* Set extended register contents of process running thread TH. */ | |
414 | extern td_err_e td_thr_setxregs (const td_thrhandle_t *__th, | |
415 | const void *__addr); | |
416 | ||
417 | ||
418 | /* Enable reporting for EVENT for thread TH. */ | |
419 | extern td_err_e td_thr_event_enable (const td_thrhandle_t *__th, int __event); | |
420 | ||
421 | /* Enable EVENT for thread TH. */ | |
422 | extern td_err_e td_thr_set_event (const td_thrhandle_t *__th, | |
423 | td_thr_events_t *__event); | |
424 | ||
425 | /* Disable EVENT for thread TH. */ | |
426 | extern td_err_e td_thr_clear_event (const td_thrhandle_t *__th, | |
427 | td_thr_events_t *__event); | |
428 | ||
429 | /* Get event message for thread TH. */ | |
430 | extern td_err_e td_thr_event_getmsg (const td_thrhandle_t *__th, | |
431 | td_event_msg_t *__msg); | |
432 | ||
433 | ||
434 | /* Set priority of thread TH. */ | |
435 | extern td_err_e td_thr_setprio (const td_thrhandle_t *__th, int __prio); | |
436 | ||
437 | ||
438 | /* Set pending signals for thread TH. */ | |
439 | extern td_err_e td_thr_setsigpending (const td_thrhandle_t *__th, | |
440 | unsigned char __n, const sigset_t *__ss); | |
441 | ||
442 | /* Set signal mask for thread TH. */ | |
443 | extern td_err_e td_thr_sigsetmask (const td_thrhandle_t *__th, | |
444 | const sigset_t *__ss); | |
445 | ||
446 | ||
447 | /* Return thread local data associated with key TK in thread TH. */ | |
448 | extern td_err_e td_thr_tsd (const td_thrhandle_t *__th, | |
449 | const thread_key_t __tk, void **__data); | |
450 | ||
451 | ||
452 | /* Suspend execution of thread TH. */ | |
453 | extern td_err_e td_thr_dbsuspend (const td_thrhandle_t *__th); | |
454 | ||
455 | /* Resume execution of thread TH. */ | |
456 | extern td_err_e td_thr_dbresume (const td_thrhandle_t *__th); | |
457 | ||
458 | #endif /* thread_db.h */ | |
574dd9a9 MK |
459 | |
460 | #endif /* HAVE_THREAD_DB_H */ |