2 * Copyright (c) 2004 Marcel Moolenaar
3 * Copyright (c) 2005 David Xu
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <proc_service.h>
35 #include <sys/types.h>
36 #include <sys/linker_set.h>
37 #include <sys/ptrace.h>
38 #include <thread_db.h>
41 #include "thread_db_int.h"
47 psaddr_t libthr_debug_addr;
48 psaddr_t thread_list_addr;
49 psaddr_t thread_active_threads_addr;
50 psaddr_t thread_keytable_addr;
51 psaddr_t thread_last_event_addr;
52 psaddr_t thread_event_mask_addr;
53 psaddr_t thread_bp_create_addr;
54 psaddr_t thread_bp_death_addr;
56 int thread_off_tlsindex;
57 int thread_off_attr_flags;
60 int thread_off_linkmap;
65 int thread_off_key_allocated;
66 int thread_off_key_destructor;
67 int thread_off_report_events;
68 int thread_off_event_mask;
69 int thread_off_event_buf;
70 int thread_state_zoombie;
71 int thread_state_running;
74 #define P2T(c) ps2td(c)
76 static int pt_validate(const td_thrhandle_t *th);
93 return TD_NOLIBTHREAD;
108 pt_ta_new(struct ps_prochandle *ph, td_thragent_t **pta)
110 #define LOOKUP_SYM(proc, sym, addr) \
111 ret = ps_pglobal_lookup(proc, NULL, sym, addr); \
113 TDBG("can not find symbol: %s\n", sym); \
114 ret = TD_NOLIBTHREAD; \
118 #define LOOKUP_VAL(proc, sym, val) \
119 ret = ps_pglobal_lookup(proc, NULL, sym, &vaddr);\
121 TDBG("can not find symbol: %s\n", sym); \
122 ret = TD_NOLIBTHREAD; \
125 ret = ps_pread(proc, vaddr, val, sizeof(int)); \
127 TDBG("can not read value of %s\n", sym);\
128 ret = TD_NOLIBTHREAD; \
139 ta = malloc(sizeof(td_thragent_t));
145 LOOKUP_SYM(ph, "_libthr_debug", &ta->libthr_debug_addr);
146 LOOKUP_SYM(ph, "_thread_list", &ta->thread_list_addr);
147 LOOKUP_SYM(ph, "_thread_active_threads",&ta->thread_active_threads_addr);
148 LOOKUP_SYM(ph, "_thread_keytable", &ta->thread_keytable_addr);
149 LOOKUP_SYM(ph, "_thread_last_event", &ta->thread_last_event_addr);
150 LOOKUP_SYM(ph, "_thread_event_mask", &ta->thread_event_mask_addr);
151 LOOKUP_SYM(ph, "_thread_bp_create", &ta->thread_bp_create_addr);
152 LOOKUP_SYM(ph, "_thread_bp_death", &ta->thread_bp_death_addr);
153 LOOKUP_VAL(ph, "_thread_off_dtv", &ta->thread_off_dtv);
154 LOOKUP_VAL(ph, "_thread_off_tlsindex", &ta->thread_off_tlsindex);
155 LOOKUP_VAL(ph, "_thread_off_attr_flags", &ta->thread_off_attr_flags);
156 LOOKUP_VAL(ph, "_thread_size_key", &ta->thread_size_key);
157 LOOKUP_VAL(ph, "_thread_off_tcb", &ta->thread_off_tcb);
158 LOOKUP_VAL(ph, "_thread_off_tid", &ta->thread_off_tid);
159 LOOKUP_VAL(ph, "_thread_off_linkmap", &ta->thread_off_linkmap);
160 LOOKUP_VAL(ph, "_thread_off_next", &ta->thread_off_next);
161 LOOKUP_VAL(ph, "_thread_off_state", &ta->thread_off_state);
162 LOOKUP_VAL(ph, "_thread_max_keys", &ta->thread_max_keys);
163 LOOKUP_VAL(ph, "_thread_off_key_allocated", &ta->thread_off_key_allocated);
164 LOOKUP_VAL(ph, "_thread_off_key_destructor", &ta->thread_off_key_destructor);
165 LOOKUP_VAL(ph, "_thread_state_running", &ta->thread_state_running);
166 LOOKUP_VAL(ph, "_thread_state_zoombie", &ta->thread_state_zoombie);
167 LOOKUP_VAL(ph, "_thread_off_report_events", &ta->thread_off_report_events);
168 LOOKUP_VAL(ph, "_thread_off_event_mask", &ta->thread_off_event_mask);
169 LOOKUP_VAL(ph, "_thread_off_event_buf", &ta->thread_off_event_buf);
172 * If this fails it probably means we're debugging a core file and
175 ps_pwrite(ph, ta->libthr_debug_addr, &dbg, sizeof(int));
185 pt_ta_delete(td_thragent_t *ta)
193 * Error returns from this write are not really a problem;
194 * the process doesn't exist any more.
196 ps_pwrite(ta->ph, ta->libthr_debug_addr, &dbg, sizeof(int));
202 pt_ta_map_id2thr(const td_thragent_t *ta, thread_t id, td_thrhandle_t *th)
204 TAILQ_HEAD(, pthread) thread_list;
213 ret = ps_pread(ta->ph, ta->thread_list_addr, &thread_list,
214 sizeof(thread_list));
217 /* Iterate through thread list to find pthread */
218 pt = (psaddr_t)thread_list.tqh_first;
220 ret = ps_pread(ta->ph, pt + ta->thread_off_tid,
226 /* get next thread */
227 ret = ps_pread(ta->ph,
228 pt + ta->thread_off_next,
242 pt_ta_map_lwp2thr(const td_thragent_t *ta, lwpid_t lwp, td_thrhandle_t *th)
244 return (pt_ta_map_id2thr(ta, lwp, th));
248 pt_ta_thr_iter(const td_thragent_t *ta,
249 td_thr_iter_f *callback, void *cbdata_p,
250 td_thr_state_e state, int ti_pri,
251 sigset_t *ti_sigmask_p,
252 unsigned int ti_user_flags)
254 TAILQ_HEAD(, pthread) thread_list;
262 ret = ps_pread(ta->ph, ta->thread_list_addr, &thread_list,
263 sizeof(thread_list));
266 pt = (psaddr_t)thread_list.tqh_first;
268 ret = ps_pread(ta->ph, pt + ta->thread_off_tid, &lwp,
272 if (lwp != 0 && lwp != TERMINATED) {
274 th.th_tid = (thread_t)lwp;
276 if ((*callback)(&th, cbdata_p))
279 /* get next thread */
280 ret = ps_pread(ta->ph, pt + ta->thread_off_next, &pt,
289 pt_ta_tsd_iter(const td_thragent_t *ta, td_key_iter_f *ki, void *arg)
293 int i, ret, allocated;
297 keytable = malloc(ta->thread_max_keys * ta->thread_size_key);
298 if (keytable == NULL)
300 ret = ps_pread(ta->ph, (psaddr_t)ta->thread_keytable_addr, keytable,
301 ta->thread_max_keys * ta->thread_size_key);
306 for (i = 0; i < ta->thread_max_keys; i++) {
307 allocated = *(int *)(keytable + i * ta->thread_size_key +
308 ta->thread_off_key_allocated);
309 destructor = *(void **)(keytable + i * ta->thread_size_key +
310 ta->thread_off_key_destructor);
312 ret = (ki)(i, destructor, arg);
324 pt_ta_event_addr(const td_thragent_t *ta, td_event_e event, td_notify_t *ptr)
331 ptr->type = NOTIFY_BPT;
332 ptr->u.bptaddr = ta->thread_bp_create_addr;
335 ptr->type = NOTIFY_BPT;
336 ptr->u.bptaddr = ta->thread_bp_death_addr;
344 pt_ta_set_event(const td_thragent_t *ta, td_thr_events_t *events)
346 td_thr_events_t mask;
350 ret = ps_pread(ta->ph, ta->thread_event_mask_addr, &mask,
355 ret = ps_pwrite(ta->ph, ta->thread_event_mask_addr, &mask,
361 pt_ta_clear_event(const td_thragent_t *ta, td_thr_events_t *events)
363 td_thr_events_t mask;
367 ret = ps_pread(ta->ph, ta->thread_event_mask_addr, &mask,
372 ret = ps_pwrite(ta->ph, ta->thread_event_mask_addr, &mask,
378 pt_ta_event_getmsg(const td_thragent_t *ta, td_event_msg_t *msg)
380 static td_thrhandle_t handle;
382 psaddr_t pt, pt_temp;
389 ret = ps_pread(ta->ph, ta->thread_last_event_addr, &pt, sizeof(pt));
395 * Take the event pointer, at the time, libthr only reports event
396 * once a time, so it is not a link list.
399 ps_pwrite(ta->ph, ta->thread_last_event_addr, &pt_temp, sizeof(pt_temp));
401 /* Read event info */
402 ret = ps_pread(ta->ph, pt + ta->thread_off_event_buf, msg, sizeof(*msg));
409 ps_pwrite(ta->ph, pt + ta->thread_off_event_buf, &tmp, sizeof(tmp));
411 pt = (psaddr_t)msg->th_p;
412 ret = ps_pread(ta->ph, pt + ta->thread_off_tid, &lwp, sizeof(lwp));
417 handle.th_thread = pt;
423 pt_dbsuspend(const td_thrhandle_t *th, int suspend)
425 td_thragent_t *ta = (td_thragent_t *)th->th_ta;
430 ret = pt_validate(th);
435 ret = ps_lstop(ta->ph, th->th_tid);
437 ret = ps_lcontinue(ta->ph, th->th_tid);
442 pt_thr_dbresume(const td_thrhandle_t *th)
446 return pt_dbsuspend(th, 0);
450 pt_thr_dbsuspend(const td_thrhandle_t *th)
454 return pt_dbsuspend(th, 1);
458 pt_thr_validate(const td_thrhandle_t *th)
465 ret = pt_ta_map_id2thr(th->th_ta, th->th_tid, &temp);
470 pt_thr_get_info(const td_thrhandle_t *th, td_thrinfo_t *info)
472 const td_thragent_t *ta = th->th_ta;
473 struct ptrace_lwpinfo linfo;
479 bzero(info, sizeof(*info));
480 ret = pt_validate(th);
483 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_state,
484 &state, sizeof(state));
487 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_report_events,
488 &info->ti_traceme, sizeof(int));
491 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_event_mask,
492 &info->ti_events, sizeof(td_thr_events_t));
495 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_tcb,
496 &info->ti_tls, sizeof(void *));
497 info->ti_lid = th->th_tid;
498 info->ti_tid = th->th_tid;
499 info->ti_thread = th->th_thread;
500 info->ti_ta_p = th->th_ta;
501 ret = ps_linfo(ta->ph, th->th_tid, &linfo);
503 info->ti_sigmask = linfo.pl_sigmask;
504 info->ti_pending = linfo.pl_siglist;
507 if (state == ta->thread_state_running)
508 info->ti_state = TD_THR_RUN;
509 else if (state == ta->thread_state_zoombie)
510 info->ti_state = TD_THR_ZOMBIE;
512 info->ti_state = TD_THR_SLEEP;
513 info->ti_type = TD_THR_USER;
519 pt_thr_getxmmregs(const td_thrhandle_t *th, char *fxsave)
521 const td_thragent_t *ta = th->th_ta;
526 ret = pt_validate(th);
530 ret = ps_lgetxmmregs(ta->ph, th->th_tid, fxsave);
536 pt_thr_getfpregs(const td_thrhandle_t *th, prfpregset_t *fpregs)
538 const td_thragent_t *ta = th->th_ta;
543 ret = pt_validate(th);
547 ret = ps_lgetfpregs(ta->ph, th->th_tid, fpregs);
552 pt_thr_getgregs(const td_thrhandle_t *th, prgregset_t gregs)
554 const td_thragent_t *ta = th->th_ta;
559 ret = pt_validate(th);
563 ret = ps_lgetregs(ta->ph, th->th_tid, gregs);
569 pt_thr_setxmmregs(const td_thrhandle_t *th, const char *fxsave)
571 const td_thragent_t *ta = th->th_ta;
576 ret = pt_validate(th);
580 ret = ps_lsetxmmregs(ta->ph, th->th_tid, fxsave);
586 pt_thr_setfpregs(const td_thrhandle_t *th, const prfpregset_t *fpregs)
588 const td_thragent_t *ta = th->th_ta;
593 ret = pt_validate(th);
597 ret = ps_lsetfpregs(ta->ph, th->th_tid, fpregs);
602 pt_thr_setgregs(const td_thrhandle_t *th, const prgregset_t gregs)
604 const td_thragent_t *ta = th->th_ta;
609 ret = pt_validate(th);
613 ret = ps_lsetregs(ta->ph, th->th_tid, gregs);
618 pt_thr_event_enable(const td_thrhandle_t *th, int en)
620 const td_thragent_t *ta = th->th_ta;
624 ret = ps_pwrite(ta->ph, th->th_thread + ta->thread_off_report_events,
630 pt_thr_set_event(const td_thrhandle_t *th, td_thr_events_t *setp)
632 const td_thragent_t *ta = th->th_ta;
633 td_thr_events_t mask;
637 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_event_mask,
638 &mask, sizeof(mask));
640 ret = ps_pwrite(ta->ph, th->th_thread + ta->thread_off_event_mask,
641 &mask, sizeof(mask));
646 pt_thr_clear_event(const td_thrhandle_t *th, td_thr_events_t *setp)
648 const td_thragent_t *ta = th->th_ta;
649 td_thr_events_t mask;
653 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_event_mask,
654 &mask, sizeof(mask));
656 ret = ps_pwrite(ta->ph, th->th_thread + ta->thread_off_event_mask,
657 &mask, sizeof(mask));
662 pt_thr_event_getmsg(const td_thrhandle_t *th, td_event_msg_t *msg)
664 static td_thrhandle_t handle;
665 td_thragent_t *ta = (td_thragent_t *)th->th_ta;
666 psaddr_t pt, pt_temp;
673 ret = ps_pread(ta->ph, ta->thread_last_event_addr, &pt_temp, sizeof(pt_temp));
677 ret = ps_pread(ta->ph, pt + ta->thread_off_event_buf, msg, sizeof(*msg));
683 * Take the event pointer, at the time, libthr only reports event
684 * once a time, so it is not a link list.
688 ps_pwrite(ta->ph, ta->thread_last_event_addr, &pt_temp, sizeof(pt_temp));
692 ps_pwrite(ta->ph, pt + ta->thread_off_event_buf, &tmp, sizeof(tmp));
694 pt = (psaddr_t)msg->th_p;
695 ret = ps_pread(ta->ph, pt + ta->thread_off_tid, &lwp, sizeof(lwp));
700 handle.th_thread = pt;
706 pt_thr_sstep(const td_thrhandle_t *th, int step)
710 return pt_validate(th);
714 pt_validate(const td_thrhandle_t *th)
717 if (th->th_tid == 0 || th->th_thread == NULL)
723 pt_thr_tls_get_addr(const td_thrhandle_t *th, void *_linkmap, size_t offset,
727 const td_thragent_t *ta = th->th_ta;
728 psaddr_t tcb_addr, *dtv_addr;
731 /* linkmap is a member of Obj_Entry */
732 obj_entry = (char *)_linkmap - ta->thread_off_linkmap;
734 /* get tlsindex of the object file */
735 ret = ps_pread(ta->ph,
736 obj_entry + ta->thread_off_tlsindex,
737 &tls_index, sizeof(tls_index));
742 ret = ps_pread(ta->ph, th->th_thread + ta->thread_off_tcb,
743 &tcb_addr, sizeof(tcb_addr));
747 /* get dtv array address */
748 ret = ps_pread(ta->ph, tcb_addr + ta->thread_off_dtv,
749 &dtv_addr, sizeof(dtv_addr));
752 /* now get the object's tls block base address */
753 ret = ps_pread(ta->ph, &dtv_addr[tls_index+1], address,
762 struct ta_ops libthr_db_ops = {
764 .to_ta_clear_event = pt_ta_clear_event,
765 .to_ta_delete = pt_ta_delete,
766 .to_ta_event_addr = pt_ta_event_addr,
767 .to_ta_event_getmsg = pt_ta_event_getmsg,
768 .to_ta_map_id2thr = pt_ta_map_id2thr,
769 .to_ta_map_lwp2thr = pt_ta_map_lwp2thr,
770 .to_ta_new = pt_ta_new,
771 .to_ta_set_event = pt_ta_set_event,
772 .to_ta_thr_iter = pt_ta_thr_iter,
773 .to_ta_tsd_iter = pt_ta_tsd_iter,
774 .to_thr_clear_event = pt_thr_clear_event,
775 .to_thr_dbresume = pt_thr_dbresume,
776 .to_thr_dbsuspend = pt_thr_dbsuspend,
777 .to_thr_event_enable = pt_thr_event_enable,
778 .to_thr_event_getmsg = pt_thr_event_getmsg,
779 .to_thr_get_info = pt_thr_get_info,
780 .to_thr_getfpregs = pt_thr_getfpregs,
781 .to_thr_getgregs = pt_thr_getgregs,
782 .to_thr_set_event = pt_thr_set_event,
783 .to_thr_setfpregs = pt_thr_setfpregs,
784 .to_thr_setgregs = pt_thr_setgregs,
785 .to_thr_validate = pt_thr_validate,
786 .to_thr_tls_get_addr = pt_thr_tls_get_addr,
788 /* FreeBSD specific extensions. */
789 .to_thr_sstep = pt_thr_sstep,
791 .to_thr_getxmmregs = pt_thr_getxmmregs,
792 .to_thr_setxmmregs = pt_thr_setxmmregs,
796 DATA_SET(__ta_ops, libthr_db_ops);