xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/annotate.c (revision afab4e300d3a9fb07dd8c80daf53d0feb3345706) 
1 /* Annotation routines for GDB.
2    Copyright (C) 1986-2020 Free Software Foundation, Inc.
3 
4    This file is part of GDB.
5 
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.
10 
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.
15 
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/>.  */
18 
19 #include "defs.h"
20 #include "annotate.h"
21 #include "value.h"
22 #include "target.h"
23 #include "gdbtypes.h"
24 #include "breakpoint.h"
25 #include "observable.h"
26 #include "inferior.h"
27 #include "infrun.h"
28 #include "top.h"
29 #include "source.h"
30 #include "objfiles.h"
31 #include "source-cache.h"
32 
33 
34 /* Prototypes for local functions.  */
35 
36 static void print_value_flags (struct type *);
37 
38 static void breakpoint_changed (struct breakpoint *b);
39 
40 
41 void (*deprecated_annotate_signalled_hook) (void);
42 void (*deprecated_annotate_signal_hook) (void);
43 
44 /* Booleans indicating whether we've emitted certain notifications.
45    Used to suppress useless repeated notifications until the next time
46    we're ready to accept more commands.  Reset whenever a prompt is
47    displayed.  */
48 static int frames_invalid_emitted;
49 static int breakpoints_invalid_emitted;
50 
51 static void
52 print_value_flags (struct type *t)
53 {
54   if (can_dereference (t))
55     printf_filtered (("*"));
56   else
57     printf_filtered (("-"));
58 }
59 
60 static void
61 annotate_breakpoints_invalid (void)
62 {
63   if (annotation_level == 2
64       && (!breakpoints_invalid_emitted
65 	  || current_ui->prompt_state != PROMPT_BLOCKED))
66     {
67       target_terminal::scoped_restore_terminal_state term_state;
68       target_terminal::ours_for_output ();
69 
70       printf_unfiltered (("\n\032\032breakpoints-invalid\n"));
71       breakpoints_invalid_emitted = 1;
72     }
73 }
74 
75 void
76 annotate_breakpoint (int num)
77 {
78   if (annotation_level > 1)
79     printf_filtered (("\n\032\032breakpoint %d\n"), num);
80 }
81 
82 void
83 annotate_catchpoint (int num)
84 {
85   if (annotation_level > 1)
86     printf_filtered (("\n\032\032catchpoint %d\n"), num);
87 }
88 
89 void
90 annotate_watchpoint (int num)
91 {
92   if (annotation_level > 1)
93     printf_filtered (("\n\032\032watchpoint %d\n"), num);
94 }
95 
96 void
97 annotate_starting (void)
98 {
99   if (annotation_level > 1)
100     printf_filtered (("\n\032\032starting\n"));
101 }
102 
103 void
104 annotate_stopped (void)
105 {
106   if (annotation_level > 1)
107     printf_filtered (("\n\032\032stopped\n"));
108 }
109 
110 void
111 annotate_exited (int exitstatus)
112 {
113   if (annotation_level > 1)
114     printf_filtered (("\n\032\032exited %d\n"), exitstatus);
115 }
116 
117 void
118 annotate_signalled (void)
119 {
120   if (deprecated_annotate_signalled_hook)
121     deprecated_annotate_signalled_hook ();
122 
123   if (annotation_level > 1)
124     printf_filtered (("\n\032\032signalled\n"));
125 }
126 
127 void
128 annotate_signal_name (void)
129 {
130   if (annotation_level == 2)
131     printf_filtered (("\n\032\032signal-name\n"));
132 }
133 
134 void
135 annotate_signal_name_end (void)
136 {
137   if (annotation_level == 2)
138     printf_filtered (("\n\032\032signal-name-end\n"));
139 }
140 
141 void
142 annotate_signal_string (void)
143 {
144   if (annotation_level == 2)
145     printf_filtered (("\n\032\032signal-string\n"));
146 }
147 
148 void
149 annotate_signal_string_end (void)
150 {
151   if (annotation_level == 2)
152     printf_filtered (("\n\032\032signal-string-end\n"));
153 }
154 
155 void
156 annotate_signal (void)
157 {
158   if (deprecated_annotate_signal_hook)
159     deprecated_annotate_signal_hook ();
160 
161   if (annotation_level > 1)
162     printf_filtered (("\n\032\032signal\n"));
163 }
164 
165 void
166 annotate_breakpoints_headers (void)
167 {
168   if (annotation_level == 2)
169     printf_filtered (("\n\032\032breakpoints-headers\n"));
170 }
171 
172 void
173 annotate_field (int num)
174 {
175   if (annotation_level == 2)
176     printf_filtered (("\n\032\032field %d\n"), num);
177 }
178 
179 void
180 annotate_breakpoints_table (void)
181 {
182   if (annotation_level == 2)
183     printf_filtered (("\n\032\032breakpoints-table\n"));
184 }
185 
186 void
187 annotate_record (void)
188 {
189   if (annotation_level == 2)
190     printf_filtered (("\n\032\032record\n"));
191 }
192 
193 void
194 annotate_breakpoints_table_end (void)
195 {
196   if (annotation_level == 2)
197     printf_filtered (("\n\032\032breakpoints-table-end\n"));
198 }
199 
200 void
201 annotate_frames_invalid (void)
202 {
203   if (annotation_level == 2
204       && (!frames_invalid_emitted
205 	  || current_ui->prompt_state != PROMPT_BLOCKED))
206     {
207       target_terminal::scoped_restore_terminal_state term_state;
208       target_terminal::ours_for_output ();
209 
210       printf_unfiltered (("\n\032\032frames-invalid\n"));
211       frames_invalid_emitted = 1;
212     }
213 }
214 
215 void
216 annotate_new_thread (void)
217 {
218   if (annotation_level > 1)
219     {
220       printf_unfiltered (("\n\032\032new-thread\n"));
221     }
222 }
223 
224 void
225 annotate_thread_changed (void)
226 {
227   if (annotation_level > 1)
228     {
229       printf_unfiltered (("\n\032\032thread-changed\n"));
230     }
231 }
232 
233 /* Emit notification on thread exit.  */
234 
235 static void
236 annotate_thread_exited (struct thread_info *t, int silent)
237 {
238   if (annotation_level > 1)
239     {
240       printf_filtered(("\n\032\032thread-exited,"
241                        "id=\"%d\",group-id=\"i%d\"\n"),
242                       t->global_num, t->inf->num);
243     }
244 }
245 
246 void
247 annotate_field_begin (struct type *type)
248 {
249   if (annotation_level == 2)
250     {
251       printf_filtered (("\n\032\032field-begin "));
252       print_value_flags (type);
253       printf_filtered (("\n"));
254     }
255 }
256 
257 void
258 annotate_field_name_end (void)
259 {
260   if (annotation_level == 2)
261     printf_filtered (("\n\032\032field-name-end\n"));
262 }
263 
264 void
265 annotate_field_value (void)
266 {
267   if (annotation_level == 2)
268     printf_filtered (("\n\032\032field-value\n"));
269 }
270 
271 void
272 annotate_field_end (void)
273 {
274   if (annotation_level == 2)
275     printf_filtered (("\n\032\032field-end\n"));
276 }
277 
278 void
279 annotate_quit (void)
280 {
281   if (annotation_level > 1)
282     printf_filtered (("\n\032\032quit\n"));
283 }
284 
285 void
286 annotate_error (void)
287 {
288   if (annotation_level > 1)
289     printf_filtered (("\n\032\032error\n"));
290 }
291 
292 void
293 annotate_error_begin (void)
294 {
295   if (annotation_level > 1)
296     fprintf_filtered (gdb_stderr, "\n\032\032error-begin\n");
297 }
298 
299 void
300 annotate_value_history_begin (int histindex, struct type *type)
301 {
302   if (annotation_level == 2)
303     {
304       printf_filtered (("\n\032\032value-history-begin %d "), histindex);
305       print_value_flags (type);
306       printf_filtered (("\n"));
307     }
308 }
309 
310 void
311 annotate_value_begin (struct type *type)
312 {
313   if (annotation_level == 2)
314     {
315       printf_filtered (("\n\032\032value-begin "));
316       print_value_flags (type);
317       printf_filtered (("\n"));
318     }
319 }
320 
321 void
322 annotate_value_history_value (void)
323 {
324   if (annotation_level == 2)
325     printf_filtered (("\n\032\032value-history-value\n"));
326 }
327 
328 void
329 annotate_value_history_end (void)
330 {
331   if (annotation_level == 2)
332     printf_filtered (("\n\032\032value-history-end\n"));
333 }
334 
335 void
336 annotate_value_end (void)
337 {
338   if (annotation_level == 2)
339     printf_filtered (("\n\032\032value-end\n"));
340 }
341 
342 void
343 annotate_display_begin (void)
344 {
345   if (annotation_level == 2)
346     printf_filtered (("\n\032\032display-begin\n"));
347 }
348 
349 void
350 annotate_display_number_end (void)
351 {
352   if (annotation_level == 2)
353     printf_filtered (("\n\032\032display-number-end\n"));
354 }
355 
356 void
357 annotate_display_format (void)
358 {
359   if (annotation_level == 2)
360     printf_filtered (("\n\032\032display-format\n"));
361 }
362 
363 void
364 annotate_display_expression (void)
365 {
366   if (annotation_level == 2)
367     printf_filtered (("\n\032\032display-expression\n"));
368 }
369 
370 void
371 annotate_display_expression_end (void)
372 {
373   if (annotation_level == 2)
374     printf_filtered (("\n\032\032display-expression-end\n"));
375 }
376 
377 void
378 annotate_display_value (void)
379 {
380   if (annotation_level == 2)
381     printf_filtered (("\n\032\032display-value\n"));
382 }
383 
384 void
385 annotate_display_end (void)
386 {
387   if (annotation_level == 2)
388     printf_filtered (("\n\032\032display-end\n"));
389 }
390 
391 void
392 annotate_arg_begin (void)
393 {
394   if (annotation_level == 2)
395     printf_filtered (("\n\032\032arg-begin\n"));
396 }
397 
398 void
399 annotate_arg_name_end (void)
400 {
401   if (annotation_level == 2)
402     printf_filtered (("\n\032\032arg-name-end\n"));
403 }
404 
405 void
406 annotate_arg_value (struct type *type)
407 {
408   if (annotation_level == 2)
409     {
410       printf_filtered (("\n\032\032arg-value "));
411       print_value_flags (type);
412       printf_filtered (("\n"));
413     }
414 }
415 
416 void
417 annotate_arg_end (void)
418 {
419   if (annotation_level == 2)
420     printf_filtered (("\n\032\032arg-end\n"));
421 }
422 
423 static void
424 annotate_source (const char *filename, int line, int character, int mid,
425 		 struct gdbarch *gdbarch, CORE_ADDR pc)
426 {
427   if (annotation_level > 1)
428     printf_filtered (("\n\032\032source "));
429   else
430     printf_filtered (("\032\032"));
431 
432   printf_filtered (("%s:%d:%d:%s:%s\n"), filename, line, character,
433 		   mid ? "middle" : "beg", paddress (gdbarch, pc));
434 }
435 
436 /* See annotate.h.  */
437 
438 bool
439 annotate_source_line (struct symtab *s, int line, int mid_statement,
440 		      CORE_ADDR pc)
441 {
442   if (annotation_level > 0)
443     {
444       const std::vector<off_t> *offsets;
445       if (!g_source_cache.get_line_charpos (s, &offsets))
446 	return false;
447       if (line > offsets->size ())
448 	return false;
449 
450       annotate_source (s->fullname, line, (int) (*offsets)[line - 1],
451 		       mid_statement, SYMTAB_OBJFILE (s)->arch (),
452 		       pc);
453 
454       /* Update the current symtab and line.  */
455       symtab_and_line sal;
456       sal.pspace = SYMTAB_PSPACE (s);
457       sal.symtab = s;
458       sal.line = line;
459       set_current_source_symtab_and_line (sal);
460 
461       return true;
462     }
463 
464   return false;
465 }
466 
467 
468 void
469 annotate_frame_begin (int level, struct gdbarch *gdbarch, CORE_ADDR pc)
470 {
471   if (annotation_level > 1)
472     printf_filtered (("\n\032\032frame-begin %d %s\n"),
473 		     level, paddress (gdbarch, pc));
474 }
475 
476 void
477 annotate_function_call (void)
478 {
479   if (annotation_level == 2)
480     printf_filtered (("\n\032\032function-call\n"));
481 }
482 
483 void
484 annotate_signal_handler_caller (void)
485 {
486   if (annotation_level == 2)
487     printf_filtered (("\n\032\032signal-handler-caller\n"));
488 }
489 
490 void
491 annotate_frame_address (void)
492 {
493   if (annotation_level == 2)
494     printf_filtered (("\n\032\032frame-address\n"));
495 }
496 
497 void
498 annotate_frame_address_end (void)
499 {
500   if (annotation_level == 2)
501     printf_filtered (("\n\032\032frame-address-end\n"));
502 }
503 
504 void
505 annotate_frame_function_name (void)
506 {
507   if (annotation_level == 2)
508     printf_filtered (("\n\032\032frame-function-name\n"));
509 }
510 
511 void
512 annotate_frame_args (void)
513 {
514   if (annotation_level == 2)
515     printf_filtered (("\n\032\032frame-args\n"));
516 }
517 
518 void
519 annotate_frame_source_begin (void)
520 {
521   if (annotation_level == 2)
522     printf_filtered (("\n\032\032frame-source-begin\n"));
523 }
524 
525 void
526 annotate_frame_source_file (void)
527 {
528   if (annotation_level == 2)
529     printf_filtered (("\n\032\032frame-source-file\n"));
530 }
531 
532 void
533 annotate_frame_source_file_end (void)
534 {
535   if (annotation_level == 2)
536     printf_filtered (("\n\032\032frame-source-file-end\n"));
537 }
538 
539 void
540 annotate_frame_source_line (void)
541 {
542   if (annotation_level == 2)
543     printf_filtered (("\n\032\032frame-source-line\n"));
544 }
545 
546 void
547 annotate_frame_source_end (void)
548 {
549   if (annotation_level == 2)
550     printf_filtered (("\n\032\032frame-source-end\n"));
551 }
552 
553 void
554 annotate_frame_where (void)
555 {
556   if (annotation_level == 2)
557     printf_filtered (("\n\032\032frame-where\n"));
558 }
559 
560 void
561 annotate_frame_end (void)
562 {
563   if (annotation_level == 2)
564     printf_filtered (("\n\032\032frame-end\n"));
565 }
566 
567 void
568 annotate_array_section_begin (int idx, struct type *elttype)
569 {
570   if (annotation_level == 2)
571     {
572       printf_filtered (("\n\032\032array-section-begin %d "), idx);
573       print_value_flags (elttype);
574       printf_filtered (("\n"));
575     }
576 }
577 
578 void
579 annotate_elt_rep (unsigned int repcount)
580 {
581   if (annotation_level == 2)
582     printf_filtered (("\n\032\032elt-rep %u\n"), repcount);
583 }
584 
585 void
586 annotate_elt_rep_end (void)
587 {
588   if (annotation_level == 2)
589     printf_filtered (("\n\032\032elt-rep-end\n"));
590 }
591 
592 void
593 annotate_elt (void)
594 {
595   if (annotation_level == 2)
596     printf_filtered (("\n\032\032elt\n"));
597 }
598 
599 void
600 annotate_array_section_end (void)
601 {
602   if (annotation_level == 2)
603     printf_filtered (("\n\032\032array-section-end\n"));
604 }
605 
606 /* Called when GDB is about to display the prompt.  Used to reset
607    annotation suppression whenever we're ready to accept new
608    frontend/user commands.  */
609 
610 void
611 annotate_display_prompt (void)
612 {
613   frames_invalid_emitted = 0;
614   breakpoints_invalid_emitted = 0;
615 }
616 
617 static void
618 breakpoint_changed (struct breakpoint *b)
619 {
620   if (b->number <= 0)
621     return;
622 
623   annotate_breakpoints_invalid ();
624 }
625 
626 void _initialize_annotate ();
627 void
628 _initialize_annotate ()
629 {
630   gdb::observers::breakpoint_created.attach (breakpoint_changed);
631   gdb::observers::breakpoint_deleted.attach (breakpoint_changed);
632   gdb::observers::breakpoint_modified.attach (breakpoint_changed);
633   gdb::observers::thread_exit.attach (annotate_thread_exited);
634 }
635