1 /* Copyright (C) 1992-1994, 1997-2000, 2003-2005, 2007-2012 Free
2 Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "gdbthread.h"
27 #include "progspace.h"
30 /* The name of the array in the GNAT runtime where the Ada Task Control
31 Block of each task is stored. */
32 #define KNOWN_TASKS_NAME "system__tasking__debug__known_tasks"
34 /* The maximum number of tasks known to the Ada runtime. */
35 static const int MAX_NUMBER_OF_KNOWN_TASKS
= 1000;
37 /* The name of the variable in the GNAT runtime where the head of a task
38 chain is saved. This is an alternate mechanism to find the list of known
40 #define KNOWN_TASKS_LIST "system__tasking__debug__first_task"
52 Master_Completion_Sleep
,
54 Interrupt_Server_Idle_Sleep
,
55 Interrupt_Server_Blocked_Interrupt_Sleep
,
59 Interrupt_Server_Blocked_On_Event_Flag
,
64 /* A short description corresponding to each possible task state. */
65 static const char *task_states
[] = {
69 N_("Child Activation Wait"),
70 N_("Accept or Select Term"),
71 N_("Waiting on entry call"),
72 N_("Async Select Wait"),
74 N_("Child Termination Wait"),
75 N_("Wait Child in Term Alt"),
80 N_("Asynchronous Hold"),
86 /* A longer description corresponding to each possible task state. */
87 static const char *long_task_states
[] = {
91 N_("Waiting for child activation"),
92 N_("Blocked in accept or select with terminate"),
93 N_("Waiting on entry call"),
94 N_("Asynchronous Selective Wait"),
96 N_("Waiting for children termination"),
97 N_("Waiting for children in terminate alternative"),
102 N_("Asynchronous Hold"),
105 N_("Blocked in selective wait statement")
108 /* The index of certain important fields in the Ada Task Control Block
109 record and sub-records. */
113 /* Fields in record Ada_Task_Control_Block. */
116 int atc_nesting_level
;
118 /* Fields in record Common_ATCB. */
123 int image_len
; /* This field may be missing. */
128 /* Fields in Task_Primitives.Private_Data. */
130 int ll_lwp
; /* This field may be missing. */
132 /* Fields in Common_ATCB.Call.all. */
136 /* This module's per-program-space data. */
138 struct ada_tasks_pspace_data
140 /* Nonzero if the data has been initialized. If set to zero,
141 it means that the data has either not been initialized, or
142 has potentially become stale. */
145 /* The ATCB record type. */
146 struct type
*atcb_type
;
148 /* The ATCB "Common" component type. */
149 struct type
*atcb_common_type
;
151 /* The type of the "ll" field, from the atcb_common_type. */
152 struct type
*atcb_ll_type
;
154 /* The type of the "call" field, from the atcb_common_type. */
155 struct type
*atcb_call_type
;
157 /* The index of various fields in the ATCB record and sub-records. */
158 struct atcb_fieldnos atcb_fieldno
;
161 /* Key to our per-program-space data. */
162 static const struct program_space_data
*ada_tasks_pspace_data_handle
;
164 typedef struct ada_task_info ada_task_info_s
;
165 DEF_VEC_O(ada_task_info_s
);
167 /* The kind of data structure used by the runtime to store the list
170 enum ada_known_tasks_kind
172 /* Use this value when we haven't determined which kind of structure
173 is being used, or when we need to recompute it.
175 We set the value of this enumerate to zero on purpose: This allows
176 us to use this enumerate in a structure where setting all fields
177 to zero will result in this kind being set to unknown. */
178 ADA_TASKS_UNKNOWN
= 0,
180 /* This value means that we did not find any task list. Unless
181 there is a bug somewhere, this means that the inferior does not
185 /* This value means that the task list is stored as an array.
186 This is the usual method, as it causes very little overhead.
187 But this method is not always used, as it does use a certain
188 amount of memory, which might be scarse in certain environments. */
191 /* This value means that the task list is stored as a linked list.
192 This has more runtime overhead than the array approach, but
193 also require less memory when the number of tasks is small. */
197 /* This module's per-inferior data. */
199 struct ada_tasks_inferior_data
201 /* The type of data structure used by the runtime to store
202 the list of Ada tasks. The value of this field influences
203 the interpretation of the known_tasks_addr field below:
204 - ADA_TASKS_UNKNOWN: The value of known_tasks_addr hasn't
206 - ADA_TASKS_NOT_FOUND: The program probably does not use tasking
207 and the known_tasks_addr is irrelevant;
208 - ADA_TASKS_ARRAY: The known_tasks is an array;
209 - ADA_TASKS_LIST: The known_tasks is a list. */
210 enum ada_known_tasks_kind known_tasks_kind
;
212 /* The address of the known_tasks structure. This is where
213 the runtime stores the information for all Ada tasks.
214 The interpretation of this field depends on KNOWN_TASKS_KIND
216 CORE_ADDR known_tasks_addr
;
218 /* When nonzero, this flag indicates that the task_list field
219 below is up to date. When set to zero, the list has either
220 not been initialized, or has potentially become stale. */
221 int task_list_valid_p
;
223 /* The list of Ada tasks.
225 Note: To each task we associate a number that the user can use to
226 reference it - this number is printed beside each task in the tasks
227 info listing displayed by "info tasks". This number is equal to
228 its index in the vector + 1. Reciprocally, to compute the index
229 of a task in the vector, we need to substract 1 from its number. */
230 VEC(ada_task_info_s
) *task_list
;
233 /* Key to our per-inferior data. */
234 static const struct inferior_data
*ada_tasks_inferior_data_handle
;
236 /* Return the ada-tasks module's data for the given program space (PSPACE).
237 If none is found, add a zero'ed one now.
239 This function always returns a valid object. */
241 static struct ada_tasks_pspace_data
*
242 get_ada_tasks_pspace_data (struct program_space
*pspace
)
244 struct ada_tasks_pspace_data
*data
;
246 data
= program_space_data (pspace
, ada_tasks_pspace_data_handle
);
249 data
= XZALLOC (struct ada_tasks_pspace_data
);
250 set_program_space_data (pspace
, ada_tasks_pspace_data_handle
, data
);
256 /* Return the ada-tasks module's data for the given inferior (INF).
257 If none is found, add a zero'ed one now.
259 This function always returns a valid object.
261 Note that we could use an observer of the inferior-created event
262 to make sure that the ada-tasks per-inferior data always exists.
263 But we prefered this approach, as it avoids this entirely as long
264 as the user does not use any of the tasking features. This is
265 quite possible, particularly in the case where the inferior does
268 static struct ada_tasks_inferior_data
*
269 get_ada_tasks_inferior_data (struct inferior
*inf
)
271 struct ada_tasks_inferior_data
*data
;
273 data
= inferior_data (inf
, ada_tasks_inferior_data_handle
);
276 data
= XZALLOC (struct ada_tasks_inferior_data
);
277 set_inferior_data (inf
, ada_tasks_inferior_data_handle
, data
);
283 /* Return the task number of the task whose ptid is PTID, or zero
284 if the task could not be found. */
287 ada_get_task_number (ptid_t ptid
)
290 struct inferior
*inf
= find_inferior_pid (ptid_get_pid (ptid
));
291 struct ada_tasks_inferior_data
*data
;
293 gdb_assert (inf
!= NULL
);
294 data
= get_ada_tasks_inferior_data (inf
);
296 for (i
= 0; i
< VEC_length (ada_task_info_s
, data
->task_list
); i
++)
297 if (ptid_equal (VEC_index (ada_task_info_s
, data
->task_list
, i
)->ptid
,
301 return 0; /* No matching task found. */
304 /* Return the task number of the task running in inferior INF which
305 matches TASK_ID , or zero if the task could not be found. */
308 get_task_number_from_id (CORE_ADDR task_id
, struct inferior
*inf
)
310 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
313 for (i
= 0; i
< VEC_length (ada_task_info_s
, data
->task_list
); i
++)
315 struct ada_task_info
*task_info
=
316 VEC_index (ada_task_info_s
, data
->task_list
, i
);
318 if (task_info
->task_id
== task_id
)
322 /* Task not found. Return 0. */
326 /* Return non-zero if TASK_NUM is a valid task number. */
329 valid_task_id (int task_num
)
331 struct ada_tasks_inferior_data
*data
;
333 ada_build_task_list ();
334 data
= get_ada_tasks_inferior_data (current_inferior ());
336 && task_num
<= VEC_length (ada_task_info_s
, data
->task_list
));
339 /* Return non-zero iff the task STATE corresponds to a non-terminated
343 ada_task_is_alive (struct ada_task_info
*task_info
)
345 return (task_info
->state
!= Terminated
);
348 /* Call the ITERATOR function once for each Ada task that hasn't been
352 iterate_over_live_ada_tasks (ada_task_list_iterator_ftype
*iterator
)
355 struct ada_task_info
*task
;
356 struct ada_tasks_inferior_data
*data
;
358 ada_build_task_list ();
359 data
= get_ada_tasks_inferior_data (current_inferior ());
360 nb_tasks
= VEC_length (ada_task_info_s
, data
->task_list
);
362 for (i
= 0; i
< nb_tasks
; i
++)
364 task
= VEC_index (ada_task_info_s
, data
->task_list
, i
);
365 if (!ada_task_is_alive (task
))
371 /* Extract the contents of the value as a string whose length is LENGTH,
372 and store the result in DEST. */
375 value_as_string (char *dest
, struct value
*val
, int length
)
377 memcpy (dest
, value_contents (val
), length
);
381 /* Extract the string image from the fat string corresponding to VAL,
382 and store it in DEST. If the string length is greater than MAX_LEN,
383 then truncate the result to the first MAX_LEN characters of the fat
387 read_fat_string_value (char *dest
, struct value
*val
, int max_len
)
389 struct value
*array_val
;
390 struct value
*bounds_val
;
393 /* The following variables are made static to avoid recomputing them
394 each time this function is called. */
395 static int initialize_fieldnos
= 1;
396 static int array_fieldno
;
397 static int bounds_fieldno
;
398 static int upper_bound_fieldno
;
400 /* Get the index of the fields that we will need to read in order
401 to extract the string from the fat string. */
402 if (initialize_fieldnos
)
404 struct type
*type
= value_type (val
);
405 struct type
*bounds_type
;
407 array_fieldno
= ada_get_field_index (type
, "P_ARRAY", 0);
408 bounds_fieldno
= ada_get_field_index (type
, "P_BOUNDS", 0);
410 bounds_type
= TYPE_FIELD_TYPE (type
, bounds_fieldno
);
411 if (TYPE_CODE (bounds_type
) == TYPE_CODE_PTR
)
412 bounds_type
= TYPE_TARGET_TYPE (bounds_type
);
413 if (TYPE_CODE (bounds_type
) != TYPE_CODE_STRUCT
)
414 error (_("Unknown task name format. Aborting"));
415 upper_bound_fieldno
= ada_get_field_index (bounds_type
, "UB0", 0);
417 initialize_fieldnos
= 0;
420 /* Get the size of the task image by checking the value of the bounds.
421 The lower bound is always 1, so we only need to read the upper bound. */
422 bounds_val
= value_ind (value_field (val
, bounds_fieldno
));
423 len
= value_as_long (value_field (bounds_val
, upper_bound_fieldno
));
425 /* Make sure that we do not read more than max_len characters... */
429 /* Extract LEN characters from the fat string. */
430 array_val
= value_ind (value_field (val
, array_fieldno
));
431 read_memory (value_address (array_val
), dest
, len
);
433 /* Add the NUL character to close the string. */
437 /* Get from the debugging information the type description of all types
438 related to the Ada Task Control Block that will be needed in order to
439 read the list of known tasks in the Ada runtime. Also return the
440 associated ATCB_FIELDNOS.
442 Error handling: Any data missing from the debugging info will cause
443 an error to be raised, and none of the return values to be set.
444 Users of this function can depend on the fact that all or none of the
445 return values will be set. */
448 get_tcb_types_info (void)
451 struct type
*common_type
;
452 struct type
*ll_type
;
453 struct type
*call_type
;
454 struct atcb_fieldnos fieldnos
;
455 struct ada_tasks_pspace_data
*pspace_data
;
457 const char *atcb_name
= "system__tasking__ada_task_control_block___XVE";
458 const char *atcb_name_fixed
= "system__tasking__ada_task_control_block";
459 const char *common_atcb_name
= "system__tasking__common_atcb";
460 const char *private_data_name
= "system__task_primitives__private_data";
461 const char *entry_call_record_name
= "system__tasking__entry_call_record";
463 /* ATCB symbols may be found in several compilation units. As we
464 are only interested in one instance, use standard (literal,
465 C-like) lookups to get the first match. */
467 struct symbol
*atcb_sym
=
468 lookup_symbol_in_language (atcb_name
, NULL
, VAR_DOMAIN
,
470 const struct symbol
*common_atcb_sym
=
471 lookup_symbol_in_language (common_atcb_name
, NULL
, VAR_DOMAIN
,
473 const struct symbol
*private_data_sym
=
474 lookup_symbol_in_language (private_data_name
, NULL
, VAR_DOMAIN
,
476 const struct symbol
*entry_call_record_sym
=
477 lookup_symbol_in_language (entry_call_record_name
, NULL
, VAR_DOMAIN
,
480 if (atcb_sym
== NULL
|| atcb_sym
->type
== NULL
)
482 /* In Ravenscar run-time libs, the ATCB does not have a dynamic
483 size, so the symbol name differs. */
484 atcb_sym
= lookup_symbol_in_language (atcb_name_fixed
, NULL
, VAR_DOMAIN
,
487 if (atcb_sym
== NULL
|| atcb_sym
->type
== NULL
)
488 error (_("Cannot find Ada_Task_Control_Block type. Aborting"));
490 type
= atcb_sym
->type
;
494 /* Get a static representation of the type record
495 Ada_Task_Control_Block. */
496 type
= atcb_sym
->type
;
497 type
= ada_template_to_fixed_record_type_1 (type
, NULL
, 0, NULL
, 0);
500 if (common_atcb_sym
== NULL
|| common_atcb_sym
->type
== NULL
)
501 error (_("Cannot find Common_ATCB type. Aborting"));
502 if (private_data_sym
== NULL
|| private_data_sym
->type
== NULL
)
503 error (_("Cannot find Private_Data type. Aborting"));
504 if (entry_call_record_sym
== NULL
|| entry_call_record_sym
->type
== NULL
)
505 error (_("Cannot find Entry_Call_Record type. Aborting"));
507 /* Get the type for Ada_Task_Control_Block.Common. */
508 common_type
= common_atcb_sym
->type
;
510 /* Get the type for Ada_Task_Control_Bloc.Common.Call.LL. */
511 ll_type
= private_data_sym
->type
;
513 /* Get the type for Common_ATCB.Call.all. */
514 call_type
= entry_call_record_sym
->type
;
516 /* Get the field indices. */
517 fieldnos
.common
= ada_get_field_index (type
, "common", 0);
518 fieldnos
.entry_calls
= ada_get_field_index (type
, "entry_calls", 1);
519 fieldnos
.atc_nesting_level
=
520 ada_get_field_index (type
, "atc_nesting_level", 1);
521 fieldnos
.state
= ada_get_field_index (common_type
, "state", 0);
522 fieldnos
.parent
= ada_get_field_index (common_type
, "parent", 1);
523 fieldnos
.priority
= ada_get_field_index (common_type
, "base_priority", 0);
524 fieldnos
.image
= ada_get_field_index (common_type
, "task_image", 1);
525 fieldnos
.image_len
= ada_get_field_index (common_type
, "task_image_len", 1);
526 fieldnos
.activation_link
= ada_get_field_index (common_type
,
527 "activation_link", 1);
528 fieldnos
.call
= ada_get_field_index (common_type
, "call", 1);
529 fieldnos
.ll
= ada_get_field_index (common_type
, "ll", 0);
530 fieldnos
.ll_thread
= ada_get_field_index (ll_type
, "thread", 0);
531 fieldnos
.ll_lwp
= ada_get_field_index (ll_type
, "lwp", 1);
532 fieldnos
.call_self
= ada_get_field_index (call_type
, "self", 0);
534 /* On certain platforms such as x86-windows, the "lwp" field has been
535 named "thread_id". This field will likely be renamed in the future,
536 but we need to support both possibilities to avoid an unnecessary
537 dependency on a recent compiler. We therefore try locating the
538 "thread_id" field in place of the "lwp" field if we did not find
540 if (fieldnos
.ll_lwp
< 0)
541 fieldnos
.ll_lwp
= ada_get_field_index (ll_type
, "thread_id", 1);
543 /* Set all the out parameters all at once, now that we are certain
544 that there are no potential error() anymore. */
545 pspace_data
= get_ada_tasks_pspace_data (current_program_space
);
546 pspace_data
->initialized_p
= 1;
547 pspace_data
->atcb_type
= type
;
548 pspace_data
->atcb_common_type
= common_type
;
549 pspace_data
->atcb_ll_type
= ll_type
;
550 pspace_data
->atcb_call_type
= call_type
;
551 pspace_data
->atcb_fieldno
= fieldnos
;
554 /* Build the PTID of the task from its COMMON_VALUE, which is the "Common"
555 component of its ATCB record. This PTID needs to match the PTID used
556 by the thread layer. */
559 ptid_from_atcb_common (struct value
*common_value
)
563 struct value
*ll_value
;
565 const struct ada_tasks_pspace_data
*pspace_data
566 = get_ada_tasks_pspace_data (current_program_space
);
568 ll_value
= value_field (common_value
, pspace_data
->atcb_fieldno
.ll
);
570 if (pspace_data
->atcb_fieldno
.ll_lwp
>= 0)
571 lwp
= value_as_address (value_field (ll_value
,
572 pspace_data
->atcb_fieldno
.ll_lwp
));
573 thread
= value_as_long (value_field (ll_value
,
574 pspace_data
->atcb_fieldno
.ll_thread
));
576 ptid
= target_get_ada_task_ptid (lwp
, thread
);
581 /* Read the ATCB data of a given task given its TASK_ID (which is in practice
582 the address of its assocated ATCB record), and store the result inside
586 read_atcb (CORE_ADDR task_id
, struct ada_task_info
*task_info
)
588 struct value
*tcb_value
;
589 struct value
*common_value
;
590 struct value
*atc_nesting_level_value
;
591 struct value
*entry_calls_value
;
592 struct value
*entry_calls_value_element
;
593 int called_task_fieldno
= -1;
594 static const char ravenscar_task_name
[] = "Ravenscar task";
595 const struct ada_tasks_pspace_data
*pspace_data
596 = get_ada_tasks_pspace_data (current_program_space
);
598 if (!pspace_data
->initialized_p
)
599 get_tcb_types_info ();
601 tcb_value
= value_from_contents_and_address (pspace_data
->atcb_type
,
603 common_value
= value_field (tcb_value
, pspace_data
->atcb_fieldno
.common
);
605 /* Fill in the task_id. */
607 task_info
->task_id
= task_id
;
609 /* Compute the name of the task.
611 Depending on the GNAT version used, the task image is either a fat
612 string, or a thin array of characters. Older versions of GNAT used
613 to use fat strings, and therefore did not need an extra field in
614 the ATCB to store the string length. For efficiency reasons, newer
615 versions of GNAT replaced the fat string by a static buffer, but this
616 also required the addition of a new field named "Image_Len" containing
617 the length of the task name. The method used to extract the task name
618 is selected depending on the existence of this field.
620 In some run-time libs (e.g. Ravenscar), the name is not in the ATCB;
621 we may want to get it from the first user frame of the stack. For now,
622 we just give a dummy name. */
624 if (pspace_data
->atcb_fieldno
.image_len
== -1)
626 if (pspace_data
->atcb_fieldno
.image
>= 0)
627 read_fat_string_value (task_info
->name
,
628 value_field (common_value
,
629 pspace_data
->atcb_fieldno
.image
),
630 sizeof (task_info
->name
) - 1);
633 struct minimal_symbol
*msym
;
635 msym
= lookup_minimal_symbol_by_pc (task_id
);
638 const char *full_name
= SYMBOL_LINKAGE_NAME (msym
);
639 const char *task_name
= full_name
;
642 /* Strip the prefix. */
643 for (p
= full_name
; *p
; p
++)
644 if (p
[0] == '_' && p
[1] == '_')
647 /* Copy the task name. */
648 strncpy (task_info
->name
, task_name
, sizeof (task_info
->name
));
649 task_info
->name
[sizeof (task_info
->name
) - 1] = 0;
653 /* No symbol found. Use a default name. */
654 strcpy (task_info
->name
, ravenscar_task_name
);
660 int len
= value_as_long
661 (value_field (common_value
,
662 pspace_data
->atcb_fieldno
.image_len
));
664 value_as_string (task_info
->name
,
665 value_field (common_value
,
666 pspace_data
->atcb_fieldno
.image
),
670 /* Compute the task state and priority. */
673 value_as_long (value_field (common_value
,
674 pspace_data
->atcb_fieldno
.state
));
675 task_info
->priority
=
676 value_as_long (value_field (common_value
,
677 pspace_data
->atcb_fieldno
.priority
));
679 /* If the ATCB contains some information about the parent task,
680 then compute it as well. Otherwise, zero. */
682 if (pspace_data
->atcb_fieldno
.parent
>= 0)
684 value_as_address (value_field (common_value
,
685 pspace_data
->atcb_fieldno
.parent
));
687 task_info
->parent
= 0;
690 /* If the ATCB contains some information about entry calls, then
691 compute the "called_task" as well. Otherwise, zero. */
693 if (pspace_data
->atcb_fieldno
.atc_nesting_level
> 0
694 && pspace_data
->atcb_fieldno
.entry_calls
> 0)
696 /* Let My_ATCB be the Ada task control block of a task calling the
697 entry of another task; then the Task_Id of the called task is
698 in My_ATCB.Entry_Calls (My_ATCB.ATC_Nesting_Level).Called_Task. */
699 atc_nesting_level_value
=
700 value_field (tcb_value
, pspace_data
->atcb_fieldno
.atc_nesting_level
);
702 ada_coerce_to_simple_array_ptr
703 (value_field (tcb_value
, pspace_data
->atcb_fieldno
.entry_calls
));
704 entry_calls_value_element
=
705 value_subscript (entry_calls_value
,
706 value_as_long (atc_nesting_level_value
));
707 called_task_fieldno
=
708 ada_get_field_index (value_type (entry_calls_value_element
),
710 task_info
->called_task
=
711 value_as_address (value_field (entry_calls_value_element
,
712 called_task_fieldno
));
716 task_info
->called_task
= 0;
719 /* If the ATCB cotnains some information about RV callers,
720 then compute the "caller_task". Otherwise, zero. */
722 task_info
->caller_task
= 0;
723 if (pspace_data
->atcb_fieldno
.call
>= 0)
725 /* Get the ID of the caller task from Common_ATCB.Call.all.Self.
726 If Common_ATCB.Call is null, then there is no caller. */
727 const CORE_ADDR call
=
728 value_as_address (value_field (common_value
,
729 pspace_data
->atcb_fieldno
.call
));
730 struct value
*call_val
;
735 value_from_contents_and_address (pspace_data
->atcb_call_type
,
737 task_info
->caller_task
=
739 (value_field (call_val
, pspace_data
->atcb_fieldno
.call_self
));
743 /* And finally, compute the task ptid. Note that there are situations
744 where this cannot be determined:
745 - The task is no longer alive - the ptid is irrelevant;
746 - We are debugging a core file - the thread is not always
747 completely preserved for us to link back a task to its
748 underlying thread. Since we do not support task switching
749 when debugging core files anyway, we don't need to compute
751 In either case, we don't need that ptid, and it is just good enough
752 to set it to null_ptid. */
754 if (target_has_execution
&& ada_task_is_alive (task_info
))
755 task_info
->ptid
= ptid_from_atcb_common (common_value
);
757 task_info
->ptid
= null_ptid
;
760 /* Read the ATCB info of the given task (identified by TASK_ID), and
761 add the result to the given inferior's TASK_LIST. */
764 add_ada_task (CORE_ADDR task_id
, struct inferior
*inf
)
766 struct ada_task_info task_info
;
767 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
769 read_atcb (task_id
, &task_info
);
770 VEC_safe_push (ada_task_info_s
, data
->task_list
, &task_info
);
773 /* Read the Known_Tasks array from the inferior memory, and store
774 it in the current inferior's TASK_LIST. Return non-zero upon success. */
777 read_known_tasks_array (CORE_ADDR known_tasks_addr
)
779 const int target_ptr_byte
=
780 gdbarch_ptr_bit (target_gdbarch
) / TARGET_CHAR_BIT
;
781 const int known_tasks_size
= target_ptr_byte
* MAX_NUMBER_OF_KNOWN_TASKS
;
782 gdb_byte
*known_tasks
= alloca (known_tasks_size
);
785 /* Build a new list by reading the ATCBs from the Known_Tasks array
786 in the Ada runtime. */
787 read_memory (known_tasks_addr
, known_tasks
, known_tasks_size
);
788 for (i
= 0; i
< MAX_NUMBER_OF_KNOWN_TASKS
; i
++)
790 struct type
*data_ptr_type
=
791 builtin_type (target_gdbarch
)->builtin_data_ptr
;
793 extract_typed_address (known_tasks
+ i
* target_ptr_byte
,
797 add_ada_task (task_id
, current_inferior ());
803 /* Read the known tasks from the inferior memory, and store it in
804 the current inferior's TASK_LIST. Return non-zero upon success. */
807 read_known_tasks_list (CORE_ADDR known_tasks_addr
)
809 const int target_ptr_byte
=
810 gdbarch_ptr_bit (target_gdbarch
) / TARGET_CHAR_BIT
;
811 gdb_byte
*known_tasks
= alloca (target_ptr_byte
);
812 struct type
*data_ptr_type
=
813 builtin_type (target_gdbarch
)->builtin_data_ptr
;
815 const struct ada_tasks_pspace_data
*pspace_data
816 = get_ada_tasks_pspace_data (current_program_space
);
819 if (pspace_data
->atcb_fieldno
.activation_link
< 0)
822 /* Build a new list by reading the ATCBs. Read head of the list. */
823 read_memory (known_tasks_addr
, known_tasks
, target_ptr_byte
);
824 task_id
= extract_typed_address (known_tasks
, data_ptr_type
);
827 struct value
*tcb_value
;
828 struct value
*common_value
;
830 add_ada_task (task_id
, current_inferior ());
832 /* Read the chain. */
833 tcb_value
= value_from_contents_and_address (pspace_data
->atcb_type
,
835 common_value
= value_field (tcb_value
, pspace_data
->atcb_fieldno
.common
);
836 task_id
= value_as_address
837 (value_field (common_value
,
838 pspace_data
->atcb_fieldno
.activation_link
));
844 /* Return the address of the variable NAME that contains all the known
845 tasks maintained in the Ada Runtime. Return NULL if the variable
846 could not be found, meaning that the inferior program probably does
850 get_known_tasks_addr (const char *name
)
852 struct minimal_symbol
*msym
;
854 msym
= lookup_minimal_symbol (name
, NULL
, NULL
);
858 return SYMBOL_VALUE_ADDRESS (msym
);
861 /* Assuming DATA is the ada-tasks' data for the current inferior,
862 set the known_tasks_kind and known_tasks_addr fields. Do nothing
863 if those fields are already set and still up to date. */
866 ada_set_current_inferior_known_tasks_addr (struct ada_tasks_inferior_data
*data
)
868 CORE_ADDR known_tasks_addr
;
870 if (data
->known_tasks_kind
!= ADA_TASKS_UNKNOWN
)
873 known_tasks_addr
= get_known_tasks_addr (KNOWN_TASKS_NAME
);
874 if (known_tasks_addr
!= 0)
876 data
->known_tasks_kind
= ADA_TASKS_ARRAY
;
877 data
->known_tasks_addr
= known_tasks_addr
;
881 known_tasks_addr
= get_known_tasks_addr (KNOWN_TASKS_LIST
);
882 if (known_tasks_addr
!= 0)
884 data
->known_tasks_kind
= ADA_TASKS_LIST
;
885 data
->known_tasks_addr
= known_tasks_addr
;
889 data
->known_tasks_kind
= ADA_TASKS_NOT_FOUND
;
890 data
->known_tasks_addr
= 0;
893 /* Read the known tasks from the current inferior's memory, and store it
894 in the current inferior's data TASK_LIST.
895 Return non-zero upon success. */
898 read_known_tasks (void)
900 struct ada_tasks_inferior_data
*data
=
901 get_ada_tasks_inferior_data (current_inferior ());
903 /* Step 1: Clear the current list, if necessary. */
904 VEC_truncate (ada_task_info_s
, data
->task_list
, 0);
906 /* Step 2: do the real work.
907 If the application does not use task, then no more needs to be done.
908 It is important to have the task list cleared (see above) before we
909 return, as we don't want a stale task list to be used... This can
910 happen for instance when debugging a non-multitasking program after
911 having debugged a multitasking one. */
912 ada_set_current_inferior_known_tasks_addr (data
);
913 gdb_assert (data
->known_tasks_kind
!= ADA_TASKS_UNKNOWN
);
915 switch (data
->known_tasks_kind
)
917 case ADA_TASKS_NOT_FOUND
: /* Tasking not in use in inferior. */
919 case ADA_TASKS_ARRAY
:
920 return read_known_tasks_array (data
->known_tasks_addr
);
922 return read_known_tasks_list (data
->known_tasks_addr
);
925 /* Step 3: Set task_list_valid_p, to avoid re-reading the Known_Tasks
926 array unless needed. Then report a success. */
927 data
->task_list_valid_p
= 1;
932 /* Build the task_list by reading the Known_Tasks array from
933 the inferior, and return the number of tasks in that list
934 (zero means that the program is not using tasking at all). */
937 ada_build_task_list (void)
939 struct ada_tasks_inferior_data
*data
;
941 if (!target_has_stack
)
942 error (_("Cannot inspect Ada tasks when program is not running"));
944 data
= get_ada_tasks_inferior_data (current_inferior ());
945 if (!data
->task_list_valid_p
)
948 return VEC_length (ada_task_info_s
, data
->task_list
);
951 /* Print a table providing a short description of all Ada tasks
952 running inside inferior INF. If ARG_STR is set, it will be
953 interpreted as a task number, and the table will be limited to
957 print_ada_task_info (struct ui_out
*uiout
,
959 struct inferior
*inf
)
961 struct ada_tasks_inferior_data
*data
;
962 int taskno
, nb_tasks
;
964 struct cleanup
*old_chain
;
967 if (ada_build_task_list () == 0)
969 ui_out_message (uiout
, 0,
970 _("Your application does not use any Ada tasks.\n"));
974 if (arg_str
!= NULL
&& arg_str
[0] != '\0')
975 taskno_arg
= value_as_long (parse_and_eval (arg_str
));
977 if (ui_out_is_mi_like_p (uiout
))
978 /* In GDB/MI mode, we want to provide the thread ID corresponding
979 to each task. This allows clients to quickly find the thread
980 associated to any task, which is helpful for commands that
981 take a --thread argument. However, in order to be able to
982 provide that thread ID, the thread list must be up to date
984 target_find_new_threads ();
986 data
= get_ada_tasks_inferior_data (inf
);
988 /* Compute the number of tasks that are going to be displayed
989 in the output. If an argument was given, there will be
990 at most 1 entry. Otherwise, there will be as many entries
995 && taskno_arg
<= VEC_length (ada_task_info_s
, data
->task_list
))
1001 nb_tasks
= VEC_length (ada_task_info_s
, data
->task_list
);
1003 nb_columns
= ui_out_is_mi_like_p (uiout
) ? 8 : 7;
1004 old_chain
= make_cleanup_ui_out_table_begin_end (uiout
, nb_columns
,
1006 ui_out_table_header (uiout
, 1, ui_left
, "current", "");
1007 ui_out_table_header (uiout
, 3, ui_right
, "id", "ID");
1008 ui_out_table_header (uiout
, 9, ui_right
, "task-id", "TID");
1009 /* The following column is provided in GDB/MI mode only because
1010 it is only really useful in that mode, and also because it
1011 allows us to keep the CLI output shorter and more compact. */
1012 if (ui_out_is_mi_like_p (uiout
))
1013 ui_out_table_header (uiout
, 4, ui_right
, "thread-id", "");
1014 ui_out_table_header (uiout
, 4, ui_right
, "parent-id", "P-ID");
1015 ui_out_table_header (uiout
, 3, ui_right
, "priority", "Pri");
1016 ui_out_table_header (uiout
, 22, ui_left
, "state", "State");
1017 /* Use ui_noalign for the last column, to prevent the CLI uiout
1018 from printing an extra space at the end of each row. This
1019 is a bit of a hack, but does get the job done. */
1020 ui_out_table_header (uiout
, 1, ui_noalign
, "name", "Name");
1021 ui_out_table_body (uiout
);
1024 taskno
<= VEC_length (ada_task_info_s
, data
->task_list
);
1027 const struct ada_task_info
*const task_info
=
1028 VEC_index (ada_task_info_s
, data
->task_list
, taskno
- 1);
1030 struct cleanup
*chain2
;
1032 gdb_assert (task_info
!= NULL
);
1034 /* If the user asked for the output to be restricted
1035 to one task only, and this is not the task, skip
1037 if (taskno_arg
&& taskno
!= taskno_arg
)
1040 chain2
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
1042 /* Print a star if this task is the current task (or the task
1043 currently selected). */
1044 if (ptid_equal (task_info
->ptid
, inferior_ptid
))
1045 ui_out_field_string (uiout
, "current", "*");
1047 ui_out_field_skip (uiout
, "current");
1049 /* Print the task number. */
1050 ui_out_field_int (uiout
, "id", taskno
);
1052 /* Print the Task ID. */
1053 ui_out_field_fmt (uiout
, "task-id", "%9lx", (long) task_info
->task_id
);
1055 /* Print the associated Thread ID. */
1056 if (ui_out_is_mi_like_p (uiout
))
1058 const int thread_id
= pid_to_thread_id (task_info
->ptid
);
1061 ui_out_field_int (uiout
, "thread-id", thread_id
);
1063 /* This should never happen unless there is a bug somewhere,
1064 but be resilient when that happens. */
1065 ui_out_field_skip (uiout
, "thread-id");
1068 /* Print the ID of the parent task. */
1069 parent_id
= get_task_number_from_id (task_info
->parent
, inf
);
1071 ui_out_field_int (uiout
, "parent-id", parent_id
);
1073 ui_out_field_skip (uiout
, "parent-id");
1075 /* Print the base priority of the task. */
1076 ui_out_field_int (uiout
, "priority", task_info
->priority
);
1078 /* Print the task current state. */
1079 if (task_info
->caller_task
)
1080 ui_out_field_fmt (uiout
, "state",
1081 _("Accepting RV with %-4d"),
1082 get_task_number_from_id (task_info
->caller_task
,
1084 else if (task_info
->state
== Entry_Caller_Sleep
1085 && task_info
->called_task
)
1086 ui_out_field_fmt (uiout
, "state",
1087 _("Waiting on RV with %-3d"),
1088 get_task_number_from_id (task_info
->called_task
,
1091 ui_out_field_string (uiout
, "state", task_states
[task_info
->state
]);
1093 /* Finally, print the task name. */
1094 ui_out_field_fmt (uiout
, "name",
1096 task_info
->name
[0] != '\0' ? task_info
->name
1099 ui_out_text (uiout
, "\n");
1100 do_cleanups (chain2
);
1103 do_cleanups (old_chain
);
1106 /* Print a detailed description of the Ada task whose ID is TASKNO_STR
1107 for the given inferior (INF). */
1110 info_task (struct ui_out
*uiout
, char *taskno_str
, struct inferior
*inf
)
1112 const int taskno
= value_as_long (parse_and_eval (taskno_str
));
1113 struct ada_task_info
*task_info
;
1114 int parent_taskno
= 0;
1115 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
1117 if (ada_build_task_list () == 0)
1119 ui_out_message (uiout
, 0,
1120 _("Your application does not use any Ada tasks.\n"));
1124 if (taskno
<= 0 || taskno
> VEC_length (ada_task_info_s
, data
->task_list
))
1125 error (_("Task ID %d not known. Use the \"info tasks\" command to\n"
1126 "see the IDs of currently known tasks"), taskno
);
1127 task_info
= VEC_index (ada_task_info_s
, data
->task_list
, taskno
- 1);
1129 /* Print the Ada task ID. */
1130 printf_filtered (_("Ada Task: %s\n"),
1131 paddress (target_gdbarch
, task_info
->task_id
));
1133 /* Print the name of the task. */
1134 if (task_info
->name
[0] != '\0')
1135 printf_filtered (_("Name: %s\n"), task_info
->name
);
1137 printf_filtered (_("<no name>\n"));
1139 /* Print the TID and LWP. */
1140 printf_filtered (_("Thread: %#lx\n"), ptid_get_tid (task_info
->ptid
));
1141 printf_filtered (_("LWP: %#lx\n"), ptid_get_lwp (task_info
->ptid
));
1143 /* Print who is the parent (if any). */
1144 if (task_info
->parent
!= 0)
1145 parent_taskno
= get_task_number_from_id (task_info
->parent
, inf
);
1148 struct ada_task_info
*parent
=
1149 VEC_index (ada_task_info_s
, data
->task_list
, parent_taskno
- 1);
1151 printf_filtered (_("Parent: %d"), parent_taskno
);
1152 if (parent
->name
[0] != '\0')
1153 printf_filtered (" (%s)", parent
->name
);
1154 printf_filtered ("\n");
1157 printf_filtered (_("No parent\n"));
1159 /* Print the base priority. */
1160 printf_filtered (_("Base Priority: %d\n"), task_info
->priority
);
1162 /* print the task current state. */
1164 int target_taskno
= 0;
1166 if (task_info
->caller_task
)
1168 target_taskno
= get_task_number_from_id (task_info
->caller_task
, inf
);
1169 printf_filtered (_("State: Accepting rendezvous with %d"),
1172 else if (task_info
->state
== Entry_Caller_Sleep
&& task_info
->called_task
)
1174 target_taskno
= get_task_number_from_id (task_info
->called_task
, inf
);
1175 printf_filtered (_("State: Waiting on task %d's entry"),
1179 printf_filtered (_("State: %s"), _(long_task_states
[task_info
->state
]));
1183 struct ada_task_info
*target_task_info
=
1184 VEC_index (ada_task_info_s
, data
->task_list
, target_taskno
- 1);
1186 if (target_task_info
->name
[0] != '\0')
1187 printf_filtered (" (%s)", target_task_info
->name
);
1190 printf_filtered ("\n");
1194 /* If ARG is empty or null, then print a list of all Ada tasks.
1195 Otherwise, print detailed information about the task whose ID
1198 Does nothing if the program doesn't use Ada tasking. */
1201 info_tasks_command (char *arg
, int from_tty
)
1203 struct ui_out
*uiout
= current_uiout
;
1205 if (arg
== NULL
|| *arg
== '\0')
1206 print_ada_task_info (uiout
, NULL
, current_inferior ());
1208 info_task (uiout
, arg
, current_inferior ());
1211 /* Print a message telling the user id of the current task.
1212 This function assumes that tasking is in use in the inferior. */
1215 display_current_task_id (void)
1217 const int current_task
= ada_get_task_number (inferior_ptid
);
1219 if (current_task
== 0)
1220 printf_filtered (_("[Current task is unknown]\n"));
1222 printf_filtered (_("[Current task is %d]\n"), current_task
);
1225 /* Parse and evaluate TIDSTR into a task id, and try to switch to
1226 that task. Print an error message if the task switch failed. */
1229 task_command_1 (char *taskno_str
, int from_tty
, struct inferior
*inf
)
1231 const int taskno
= value_as_long (parse_and_eval (taskno_str
));
1232 struct ada_task_info
*task_info
;
1233 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
1235 if (taskno
<= 0 || taskno
> VEC_length (ada_task_info_s
, data
->task_list
))
1236 error (_("Task ID %d not known. Use the \"info tasks\" command to\n"
1237 "see the IDs of currently known tasks"), taskno
);
1238 task_info
= VEC_index (ada_task_info_s
, data
->task_list
, taskno
- 1);
1240 if (!ada_task_is_alive (task_info
))
1241 error (_("Cannot switch to task %d: Task is no longer running"), taskno
);
1243 /* On some platforms, the thread list is not updated until the user
1244 performs a thread-related operation (by using the "info threads"
1245 command, for instance). So this thread list may not be up to date
1246 when the user attempts this task switch. Since we cannot switch
1247 to the thread associated to our task if GDB does not know about
1248 that thread, we need to make sure that any new threads gets added
1249 to the thread list. */
1250 target_find_new_threads ();
1252 /* Verify that the ptid of the task we want to switch to is valid
1253 (in other words, a ptid that GDB knows about). Otherwise, we will
1254 cause an assertion failure later on, when we try to determine
1255 the ptid associated thread_info data. We should normally never
1256 encounter such an error, but the wrong ptid can actually easily be
1257 computed if target_get_ada_task_ptid has not been implemented for
1258 our target (yet). Rather than cause an assertion error in that case,
1259 it's nicer for the user to just refuse to perform the task switch. */
1260 if (!find_thread_ptid (task_info
->ptid
))
1261 error (_("Unable to compute thread ID for task %d.\n"
1262 "Cannot switch to this task."),
1265 switch_to_thread (task_info
->ptid
);
1266 ada_find_printable_frame (get_selected_frame (NULL
));
1267 printf_filtered (_("[Switching to task %d]\n"), taskno
);
1268 print_stack_frame (get_selected_frame (NULL
),
1269 frame_relative_level (get_selected_frame (NULL
)), 1);
1273 /* Print the ID of the current task if TASKNO_STR is empty or NULL.
1274 Otherwise, switch to the task indicated by TASKNO_STR. */
1277 task_command (char *taskno_str
, int from_tty
)
1279 struct ui_out
*uiout
= current_uiout
;
1281 if (ada_build_task_list () == 0)
1283 ui_out_message (uiout
, 0,
1284 _("Your application does not use any Ada tasks.\n"));
1288 if (taskno_str
== NULL
|| taskno_str
[0] == '\0')
1289 display_current_task_id ();
1292 /* Task switching in core files doesn't work, either because:
1293 1. Thread support is not implemented with core files
1294 2. Thread support is implemented, but the thread IDs created
1295 after having read the core file are not the same as the ones
1296 that were used during the program life, before the crash.
1297 As a consequence, there is no longer a way for the debugger
1298 to find the associated thead ID of any given Ada task.
1299 So, instead of attempting a task switch without giving the user
1300 any clue as to what might have happened, just error-out with
1301 a message explaining that this feature is not supported. */
1302 if (!target_has_execution
)
1304 Task switching not supported when debugging from core files\n\
1305 (use thread support instead)"));
1306 task_command_1 (taskno_str
, from_tty
, current_inferior ());
1310 /* Indicate that the given inferior's task list may have changed,
1311 so invalidate the cache. */
1314 ada_task_list_changed (struct inferior
*inf
)
1316 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
1318 data
->task_list_valid_p
= 0;
1321 /* Invalidate the per-program-space data. */
1324 ada_tasks_invalidate_pspace_data (struct program_space
*pspace
)
1326 get_ada_tasks_pspace_data (pspace
)->initialized_p
= 0;
1329 /* Invalidate the per-inferior data. */
1332 ada_tasks_invalidate_inferior_data (struct inferior
*inf
)
1334 struct ada_tasks_inferior_data
*data
= get_ada_tasks_inferior_data (inf
);
1336 data
->known_tasks_kind
= ADA_TASKS_UNKNOWN
;
1337 data
->task_list_valid_p
= 0;
1340 /* The 'normal_stop' observer notification callback. */
1343 ada_normal_stop_observer (struct bpstats
*unused_args
, int unused_args2
)
1345 /* The inferior has been resumed, and just stopped. This means that
1346 our task_list needs to be recomputed before it can be used again. */
1347 ada_task_list_changed (current_inferior ());
1350 /* A routine to be called when the objfiles have changed. */
1353 ada_new_objfile_observer (struct objfile
*objfile
)
1355 struct inferior
*inf
;
1357 /* Invalidate the relevant data in our program-space data. */
1359 if (objfile
== NULL
)
1361 /* All objfiles are being cleared, so we should clear all
1362 our caches for all program spaces. */
1363 struct program_space
*pspace
;
1365 for (pspace
= program_spaces
; pspace
!= NULL
; pspace
= pspace
->next
)
1366 ada_tasks_invalidate_pspace_data (pspace
);
1370 /* The associated program-space data might have changed after
1371 this objfile was added. Invalidate all cached data. */
1372 ada_tasks_invalidate_pspace_data (objfile
->pspace
);
1375 /* Invalidate the per-inferior cache for all inferiors using
1376 this objfile (or, in other words, for all inferiors who have
1377 the same program-space as the objfile's program space).
1378 If all objfiles are being cleared (OBJFILE is NULL), then
1379 clear the caches for all inferiors. */
1381 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
1382 if (objfile
== NULL
|| inf
->pspace
== objfile
->pspace
)
1383 ada_tasks_invalidate_inferior_data (inf
);
1386 /* Provide a prototype to silence -Wmissing-prototypes. */
1387 extern initialize_file_ftype _initialize_tasks
;
1390 _initialize_tasks (void)
1392 ada_tasks_pspace_data_handle
= register_program_space_data ();
1393 ada_tasks_inferior_data_handle
= register_inferior_data ();
1395 /* Attach various observers. */
1396 observer_attach_normal_stop (ada_normal_stop_observer
);
1397 observer_attach_new_objfile (ada_new_objfile_observer
);
1399 /* Some new commands provided by this module. */
1400 add_info ("tasks", info_tasks_command
,
1401 _("Provide information about all known Ada tasks"));
1402 add_cmd ("task", class_run
, task_command
,
1403 _("Use this command to switch between Ada tasks.\n\
1404 Without argument, this command simply prints the current task ID"),