1 /* Ada Ravenscar thread support.
3 Copyright (C) 2004-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdbthread.h"
27 #include "ravenscar-thread.h"
28 #include "observable.h"
33 #include <unordered_map>
35 /* This module provides support for "Ravenscar" tasks (Ada) when
36 debugging on bare-metal targets.
38 The typical situation is when debugging a bare-metal target over
39 the remote protocol. In that situation, the system does not know
40 about high-level concepts such as threads, only about some code
41 running on one or more CPUs. And since the remote protocol does not
42 provide any handling for CPUs, the de facto standard for handling
43 them is to have one thread per CPU, where the thread's ptid has
44 its lwp field set to the CPU number (eg: 1 for the first CPU,
45 2 for the second one, etc). This module will make that assumption.
47 This module then creates and maintains the list of threads based
48 on the list of Ada tasks, with one thread per Ada task. The convention
49 is that threads corresponding to the CPUs (see assumption above)
50 have a ptid_t of the form (PID, LWP, 0), while threads corresponding
51 to our Ada tasks have a ptid_t of the form (PID, 0, TID) where TID
52 is the Ada task's ID as extracted from Ada runtime information.
54 Switching to a given Ada task (or its underlying thread) is performed
55 by fetching the registers of that task from the memory area where
56 the registers were saved. For any of the other operations, the
57 operation is performed by first finding the CPU on which the task
58 is running, switching to its corresponding ptid, and then performing
59 the operation on that ptid using the target beneath us. */
61 /* If true, ravenscar task support is enabled. */
62 static bool ravenscar_task_support
= true;
64 static const char running_thread_name
[] = "__gnat_running_thread_table";
66 static const char known_tasks_name
[] = "system__tasking__debug__known_tasks";
67 static const char first_task_name
[] = "system__tasking__debug__first_task";
69 static const char ravenscar_runtime_initializer
[]
70 = "system__bb__threads__initialize";
72 static const target_info ravenscar_target_info
= {
74 N_("Ravenscar tasks."),
75 N_("Ravenscar tasks support.")
78 struct ravenscar_thread_target final
: public target_ops
80 ravenscar_thread_target ()
81 : m_base_ptid (inferior_ptid
)
85 const target_info
&info () const override
86 { return ravenscar_target_info
; }
88 strata
stratum () const override
{ return thread_stratum
; }
90 ptid_t
wait (ptid_t
, struct target_waitstatus
*, int) override
;
91 void resume (ptid_t
, int, enum gdb_signal
) override
;
93 void fetch_registers (struct regcache
*, int) override
;
94 void store_registers (struct regcache
*, int) override
;
96 void prepare_to_store (struct regcache
*) override
;
98 bool stopped_by_sw_breakpoint () override
;
100 bool stopped_by_hw_breakpoint () override
;
102 bool stopped_by_watchpoint () override
;
104 bool stopped_data_address (CORE_ADDR
*) override
;
106 enum target_xfer_status
xfer_partial (enum target_object object
,
109 const gdb_byte
*writebuf
,
110 ULONGEST offset
, ULONGEST len
,
111 ULONGEST
*xfered_len
) override
;
113 bool thread_alive (ptid_t ptid
) override
;
115 int core_of_thread (ptid_t ptid
) override
;
117 void update_thread_list () override
;
119 std::string
pid_to_str (ptid_t
) override
;
121 ptid_t
get_ada_task_ptid (long lwp
, long thread
) override
;
123 struct btrace_target_info
*enable_btrace (ptid_t ptid
,
124 const struct btrace_config
*conf
)
127 ptid
= get_base_thread_from_ravenscar_task (ptid
);
128 return beneath ()->enable_btrace (ptid
, conf
);
131 void mourn_inferior () override
;
133 void close () override
138 thread_info
*add_active_thread ();
142 /* PTID of the last thread that received an event.
143 This can be useful to determine the associated task that received
144 the event, to make it the current task. */
147 ptid_t
active_task (int cpu
);
148 bool task_is_currently_active (ptid_t ptid
);
149 bool runtime_initialized ();
150 int get_thread_base_cpu (ptid_t ptid
);
151 ptid_t
get_base_thread_from_ravenscar_task (ptid_t ptid
);
152 void add_thread (struct ada_task_info
*task
);
154 /* This maps a TID to the CPU on which it was running. This is
155 needed because sometimes the runtime will report an active task
156 that hasn't yet been put on the list of tasks that is read by
158 std::unordered_map
<long, int> m_cpu_map
;
161 /* Return true iff PTID corresponds to a ravenscar task. */
164 is_ravenscar_task (ptid_t ptid
)
166 /* By construction, ravenscar tasks have their LWP set to zero.
167 Also make sure that the TID is nonzero, as some remotes, when
168 asked for the list of threads, will return the first thread
169 as having its TID set to zero. For instance, TSIM version
170 2.0.48 for LEON3 sends 'm0' as a reply to the 'qfThreadInfo'
171 query, which the remote protocol layer then treats as a thread
172 whose TID is 0. This is obviously not a ravenscar task. */
173 return ptid
.lwp () == 0 && ptid
.tid () != 0;
176 /* Given PTID, which can be either a ravenscar task or a CPU thread,
177 return which CPU that ptid is running on.
179 This assume that PTID is a valid ptid_t. Otherwise, a gdb_assert
180 will be triggered. */
183 ravenscar_thread_target::get_thread_base_cpu (ptid_t ptid
)
187 if (is_ravenscar_task (ptid
))
189 /* Prefer to not read inferior memory if possible, to avoid
190 reentrancy problems with xfer_partial. */
191 auto iter
= m_cpu_map
.find (ptid
.tid ());
193 if (iter
!= m_cpu_map
.end ())
194 base_cpu
= iter
->second
;
197 struct ada_task_info
*task_info
= ada_get_task_info_from_ptid (ptid
);
199 gdb_assert (task_info
!= NULL
);
200 base_cpu
= task_info
->base_cpu
;
205 /* We assume that the LWP of the PTID is equal to the CPU number. */
206 base_cpu
= ptid
.lwp ();
212 /* Given a ravenscar task (identified by its ptid_t PTID), return true
213 if this task is the currently active task on the cpu that task is
216 In other words, this function determine which CPU this task is
217 currently running on, and then return nonzero if the CPU in question
218 is executing the code for that task. If that's the case, then
219 that task's registers are in the CPU bank. Otherwise, the task
220 is currently suspended, and its registers have been saved in memory. */
223 ravenscar_thread_target::task_is_currently_active (ptid_t ptid
)
225 ptid_t active_task_ptid
= active_task (get_thread_base_cpu (ptid
));
227 return ptid
== active_task_ptid
;
230 /* Return the CPU thread (as a ptid_t) on which the given ravenscar
233 This is the thread that corresponds to the CPU on which the task
237 ravenscar_thread_target::get_base_thread_from_ravenscar_task (ptid_t ptid
)
241 if (!is_ravenscar_task (ptid
))
244 base_cpu
= get_thread_base_cpu (ptid
);
245 return ptid_t (ptid
.pid (), base_cpu
, 0);
248 /* Fetch the ravenscar running thread from target memory, make sure
249 there's a corresponding thread in the thread list, and return it.
250 If the runtime is not initialized, return NULL. */
253 ravenscar_thread_target::add_active_thread ()
255 process_stratum_target
*proc_target
256 = as_process_stratum_target (this->beneath ());
260 gdb_assert (!is_ravenscar_task (m_base_ptid
));
261 base_cpu
= get_thread_base_cpu (m_base_ptid
);
263 if (!runtime_initialized ())
266 /* Make sure we set m_base_ptid before calling active_task
267 as the latter relies on it. */
268 ptid_t active_ptid
= active_task (base_cpu
);
269 gdb_assert (active_ptid
!= null_ptid
);
271 /* The running thread may not have been added to
272 system.tasking.debug's list yet; so ravenscar_update_thread_list
273 may not always add it to the thread list. Add it here. */
274 thread_info
*active_thr
= find_thread_ptid (proc_target
, active_ptid
);
275 if (active_thr
== nullptr)
277 active_thr
= ::add_thread (proc_target
, active_ptid
);
278 m_cpu_map
[active_ptid
.tid ()] = base_cpu
;
283 /* The Ravenscar Runtime exports a symbol which contains the ID of
284 the thread that is currently running. Try to locate that symbol
285 and return its associated minimal symbol.
286 Return NULL if not found. */
288 static struct bound_minimal_symbol
289 get_running_thread_msymbol ()
291 struct bound_minimal_symbol msym
;
293 msym
= lookup_minimal_symbol (running_thread_name
, NULL
, NULL
);
295 /* Older versions of the GNAT runtime were using a different
296 (less ideal) name for the symbol where the active thread ID
297 is stored. If we couldn't find the symbol using the latest
298 name, then try the old one. */
299 msym
= lookup_minimal_symbol ("running_thread", NULL
, NULL
);
304 /* Return True if the Ada Ravenscar run-time can be found in the
308 has_ravenscar_runtime ()
310 struct bound_minimal_symbol msym_ravenscar_runtime_initializer
311 = lookup_minimal_symbol (ravenscar_runtime_initializer
, NULL
, NULL
);
312 struct bound_minimal_symbol msym_known_tasks
313 = lookup_minimal_symbol (known_tasks_name
, NULL
, NULL
);
314 struct bound_minimal_symbol msym_first_task
315 = lookup_minimal_symbol (first_task_name
, NULL
, NULL
);
316 struct bound_minimal_symbol msym_running_thread
317 = get_running_thread_msymbol ();
319 return (msym_ravenscar_runtime_initializer
.minsym
320 && (msym_known_tasks
.minsym
|| msym_first_task
.minsym
)
321 && msym_running_thread
.minsym
);
324 /* Return True if the Ada Ravenscar run-time can be found in the
325 application, and if it has been initialized on target. */
328 ravenscar_thread_target::runtime_initialized ()
330 return active_task (1) != null_ptid
;
333 /* Return the ID of the thread that is currently running.
334 Return 0 if the ID could not be determined. */
337 get_running_thread_id (int cpu
)
339 struct bound_minimal_symbol object_msym
= get_running_thread_msymbol ();
343 CORE_ADDR object_addr
;
344 struct type
*builtin_type_void_data_ptr
345 = builtin_type (target_gdbarch ())->builtin_data_ptr
;
347 if (!object_msym
.minsym
)
350 object_size
= TYPE_LENGTH (builtin_type_void_data_ptr
);
351 object_addr
= (BMSYMBOL_VALUE_ADDRESS (object_msym
)
352 + (cpu
- 1) * object_size
);
353 buf_size
= object_size
;
354 buf
= (gdb_byte
*) alloca (buf_size
);
355 read_memory (object_addr
, buf
, buf_size
);
356 return extract_typed_address (buf
, builtin_type_void_data_ptr
);
360 ravenscar_thread_target::resume (ptid_t ptid
, int step
,
361 enum gdb_signal siggnal
)
363 /* If we see a wildcard resume, we simply pass that on. Otherwise,
364 arrange to resume the base ptid. */
365 inferior_ptid
= m_base_ptid
;
368 /* We only have one process, so resume all threads of it. */
369 ptid
= minus_one_ptid
;
371 else if (ptid
!= minus_one_ptid
)
373 beneath ()->resume (ptid
, step
, siggnal
);
377 ravenscar_thread_target::wait (ptid_t ptid
,
378 struct target_waitstatus
*status
,
381 process_stratum_target
*beneath
382 = as_process_stratum_target (this->beneath ());
385 if (ptid
!= minus_one_ptid
)
387 event_ptid
= beneath
->wait (ptid
, status
, 0);
388 /* Find any new threads that might have been created, and return the
391 Only do it if the program is still alive, though. Otherwise,
392 this causes problems when debugging through the remote protocol,
393 because we might try switching threads (and thus sending packets)
394 after the remote has disconnected. */
395 if (status
->kind
!= TARGET_WAITKIND_EXITED
396 && status
->kind
!= TARGET_WAITKIND_SIGNALLED
397 && runtime_initialized ())
399 m_base_ptid
= event_ptid
;
400 this->update_thread_list ();
401 return this->add_active_thread ()->ptid
;
406 /* Add the thread associated to the given TASK to the thread list
407 (if the thread has already been added, this is a no-op). */
410 ravenscar_thread_target::add_thread (struct ada_task_info
*task
)
412 if (find_thread_ptid (current_inferior (), task
->ptid
) == NULL
)
414 ::add_thread (current_inferior ()->process_target (), task
->ptid
);
415 m_cpu_map
[task
->ptid
.tid ()] = task
->base_cpu
;
420 ravenscar_thread_target::update_thread_list ()
422 /* Do not clear the thread list before adding the Ada task, to keep
423 the thread that the process stratum has included into it
424 (m_base_ptid) and the running thread, that may not have been included
425 to system.tasking.debug's list yet. */
427 iterate_over_live_ada_tasks ([=] (struct ada_task_info
*task
)
429 this->add_thread (task
);
434 ravenscar_thread_target::active_task (int cpu
)
436 CORE_ADDR tid
= get_running_thread_id (cpu
);
441 return ptid_t (m_base_ptid
.pid (), 0, tid
);
445 ravenscar_thread_target::thread_alive (ptid_t ptid
)
447 /* Ravenscar tasks are non-terminating. */
452 ravenscar_thread_target::pid_to_str (ptid_t ptid
)
454 if (!is_ravenscar_task (ptid
))
455 return beneath ()->pid_to_str (ptid
);
457 return string_printf ("Ravenscar Thread %#x", (int) ptid
.tid ());
460 /* Temporarily set the ptid of a regcache to some other value. When
461 this object is destroyed, the regcache's original ptid is
464 class temporarily_change_regcache_ptid
468 temporarily_change_regcache_ptid (struct regcache
*regcache
, ptid_t new_ptid
)
469 : m_regcache (regcache
),
470 m_save_ptid (regcache
->ptid ())
472 m_regcache
->set_ptid (new_ptid
);
475 ~temporarily_change_regcache_ptid ()
477 m_regcache
->set_ptid (m_save_ptid
);
483 struct regcache
*m_regcache
;
484 /* The saved ptid. */
489 ravenscar_thread_target::fetch_registers (struct regcache
*regcache
, int regnum
)
491 ptid_t ptid
= regcache
->ptid ();
493 if (runtime_initialized () && is_ravenscar_task (ptid
))
495 if (task_is_currently_active (ptid
))
497 ptid_t base
= get_base_thread_from_ravenscar_task (ptid
);
498 temporarily_change_regcache_ptid
changer (regcache
, base
);
499 beneath ()->fetch_registers (regcache
, regnum
);
503 struct gdbarch
*gdbarch
= regcache
->arch ();
504 struct ravenscar_arch_ops
*arch_ops
505 = gdbarch_ravenscar_ops (gdbarch
);
507 arch_ops
->fetch_registers (regcache
, regnum
);
511 beneath ()->fetch_registers (regcache
, regnum
);
515 ravenscar_thread_target::store_registers (struct regcache
*regcache
,
518 ptid_t ptid
= regcache
->ptid ();
520 if (runtime_initialized () && is_ravenscar_task (ptid
))
522 if (task_is_currently_active (ptid
))
524 ptid_t base
= get_base_thread_from_ravenscar_task (ptid
);
525 temporarily_change_regcache_ptid
changer (regcache
, base
);
526 beneath ()->store_registers (regcache
, regnum
);
530 struct gdbarch
*gdbarch
= regcache
->arch ();
531 struct ravenscar_arch_ops
*arch_ops
532 = gdbarch_ravenscar_ops (gdbarch
);
534 arch_ops
->store_registers (regcache
, regnum
);
538 beneath ()->store_registers (regcache
, regnum
);
542 ravenscar_thread_target::prepare_to_store (struct regcache
*regcache
)
544 ptid_t ptid
= regcache
->ptid ();
546 if (runtime_initialized () && is_ravenscar_task (ptid
))
548 if (task_is_currently_active (ptid
))
550 ptid_t base
= get_base_thread_from_ravenscar_task (ptid
);
551 temporarily_change_regcache_ptid
changer (regcache
, base
);
552 beneath ()->prepare_to_store (regcache
);
560 beneath ()->prepare_to_store (regcache
);
563 /* Implement the to_stopped_by_sw_breakpoint target_ops "method". */
566 ravenscar_thread_target::stopped_by_sw_breakpoint ()
568 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
569 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
570 return beneath ()->stopped_by_sw_breakpoint ();
573 /* Implement the to_stopped_by_hw_breakpoint target_ops "method". */
576 ravenscar_thread_target::stopped_by_hw_breakpoint ()
578 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
579 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
580 return beneath ()->stopped_by_hw_breakpoint ();
583 /* Implement the to_stopped_by_watchpoint target_ops "method". */
586 ravenscar_thread_target::stopped_by_watchpoint ()
588 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
589 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
590 return beneath ()->stopped_by_watchpoint ();
593 /* Implement the to_stopped_data_address target_ops "method". */
596 ravenscar_thread_target::stopped_data_address (CORE_ADDR
*addr_p
)
598 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
599 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
600 return beneath ()->stopped_data_address (addr_p
);
604 ravenscar_thread_target::mourn_inferior ()
606 m_base_ptid
= null_ptid
;
607 target_ops
*beneath
= this->beneath ();
608 unpush_target (this);
609 beneath
->mourn_inferior ();
612 /* Implement the to_core_of_thread target_ops "method". */
615 ravenscar_thread_target::core_of_thread (ptid_t ptid
)
617 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
618 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
619 return beneath ()->core_of_thread (inferior_ptid
);
622 /* Implement the target xfer_partial method. */
624 enum target_xfer_status
625 ravenscar_thread_target::xfer_partial (enum target_object object
,
628 const gdb_byte
*writebuf
,
629 ULONGEST offset
, ULONGEST len
,
630 ULONGEST
*xfered_len
)
632 scoped_restore save_ptid
= make_scoped_restore (&inferior_ptid
);
633 /* Calling get_base_thread_from_ravenscar_task can read memory from
634 the inferior. However, that function is written to prefer our
635 internal map, so it should not result in recursive calls in
637 inferior_ptid
= get_base_thread_from_ravenscar_task (inferior_ptid
);
638 return beneath ()->xfer_partial (object
, annex
, readbuf
, writebuf
,
639 offset
, len
, xfered_len
);
642 /* Observer on inferior_created: push ravenscar thread stratum if needed. */
645 ravenscar_inferior_created (struct target_ops
*target
, int from_tty
)
649 if (!ravenscar_task_support
650 || gdbarch_ravenscar_ops (target_gdbarch ()) == NULL
651 || !has_ravenscar_runtime ())
654 err_msg
= ada_get_tcb_types_info ();
657 warning (_("%s. Task/thread support disabled."), err_msg
);
661 ravenscar_thread_target
*rtarget
= new ravenscar_thread_target ();
662 push_target (target_ops_up (rtarget
));
663 thread_info
*thr
= rtarget
->add_active_thread ();
665 switch_to_thread (thr
);
669 ravenscar_thread_target::get_ada_task_ptid (long lwp
, long thread
)
671 return ptid_t (m_base_ptid
.pid (), 0, thread
);
674 /* Command-list for the "set/show ravenscar" prefix command. */
675 static struct cmd_list_element
*set_ravenscar_list
;
676 static struct cmd_list_element
*show_ravenscar_list
;
678 /* Implement the "show ravenscar task-switching" command. */
681 show_ravenscar_task_switching_command (struct ui_file
*file
, int from_tty
,
682 struct cmd_list_element
*c
,
685 if (ravenscar_task_support
)
686 fprintf_filtered (file
, _("\
687 Support for Ravenscar task/thread switching is enabled\n"));
689 fprintf_filtered (file
, _("\
690 Support for Ravenscar task/thread switching is disabled\n"));
693 /* Module startup initialization function, automagically called by
696 void _initialize_ravenscar ();
698 _initialize_ravenscar ()
700 /* Notice when the inferior is created in order to push the
701 ravenscar ops if needed. */
702 gdb::observers::inferior_created
.attach (ravenscar_inferior_created
);
704 add_basic_prefix_cmd ("ravenscar", no_class
,
705 _("Prefix command for changing Ravenscar-specific settings."),
706 &set_ravenscar_list
, "set ravenscar ", 0, &setlist
);
708 add_show_prefix_cmd ("ravenscar", no_class
,
709 _("Prefix command for showing Ravenscar-specific settings."),
710 &show_ravenscar_list
, "show ravenscar ", 0, &showlist
);
712 add_setshow_boolean_cmd ("task-switching", class_obscure
,
713 &ravenscar_task_support
, _("\
714 Enable or disable support for GNAT Ravenscar tasks."), _("\
715 Show whether support for GNAT Ravenscar tasks is enabled."),
717 Enable or disable support for task/thread switching with the GNAT\n\
718 Ravenscar run-time library for bareboard configuration."),
719 NULL
, show_ravenscar_task_switching_command
,
720 &set_ravenscar_list
, &show_ravenscar_list
);