1 /* Skipping uninteresting files and functions while stepping.
3 Copyright (C) 2011-2012 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "gdb_string.h"
27 #include "completer.h"
29 #include "cli/cli-utils.h"
30 #include "arch-utils.h"
33 #include "exceptions.h"
34 #include "breakpoint.h" /* for get_sal_arch () */
40 /* NULL if this isn't a skiplist entry for an entire file.
41 The skiplist entry owns this pointer. */
44 /* The name of the marked-for-skip function, if this is a skiplist
45 entry for a function. Note that this might be non-null even if
46 the pc is 0 if the entry is pending a shared library load.
48 The skiplist entry owns this pointer. */
51 /* 0 if this is a skiplist entry for an entire file, or if this
52 entry will be on a function, pending a shared library load. */
55 /* Architecture we used to create the skiplist entry. May be null
56 if the entry is pending a shared library load. */
57 struct gdbarch
*gdbarch
;
62 struct skiplist_entry
*next
;
65 static void skip_function_command (char *arg
, int from_tty
);
66 static void skip_file_command (char *arg
, int from_tty
);
67 static void skip_info (char *arg
, int from_tty
);
69 static void add_skiplist_entry (struct skiplist_entry
*e
);
70 static void skip_function_pc (CORE_ADDR pc
, const char *name
,
74 static struct skiplist_entry
*skiplist_entry_chain
;
75 static int skiplist_entry_count
;
77 #define ALL_SKIPLIST_ENTRIES(E) \
78 for (E = skiplist_entry_chain; E; E = E->next)
80 #define ALL_SKIPLIST_ENTRIES_SAFE(E,TMP) \
81 for (E = skiplist_entry_chain; \
82 E ? (TMP = E->next, 1) : 0; \
86 skip_file_command (char *arg
, int from_tty
)
88 struct skiplist_entry
*e
;
89 struct symtab
*symtab
;
93 /* If no argument was given, try to default to the last
94 displayed codepoint. */
97 symtab
= get_last_displayed_symtab ();
99 error (_("No default file now."));
101 filename
= symtab
->filename
;
105 symtab
= lookup_symtab (arg
);
108 fprintf_filtered (gdb_stderr
, _("No source file named %s.\n"), arg
);
110 Ignore file pending future shared library load? ")))
117 filename
= symtab
->filename
;
120 e
= XZALLOC (struct skiplist_entry
);
121 e
->filename
= xstrdup (filename
);
123 e
->pending
= pending
;
125 e
->gdbarch
= get_objfile_arch (symtab
->objfile
);
127 add_skiplist_entry (e
);
129 printf_filtered (_("File %s will be skipped when stepping.\n"), filename
);
133 skip_function_command (char *arg
, int from_tty
)
136 const char *name
= NULL
;
138 /* Default to the current function if no argument is given. */
142 if (!last_displayed_sal_is_valid ())
143 error (_("No default function now."));
145 pc
= get_last_displayed_addr ();
146 if (!find_pc_partial_function (pc
, &name
, &func_pc
, 0))
148 error (_("No function found containing current program point %s."),
149 paddress (get_current_arch (), pc
));
151 skip_function_pc (func_pc
, name
, get_current_arch (), 0);
155 /* Decode arg. We set funfirstline=1 so decode_line_1 will give us the
156 first line of the function specified, if it can, and so that we'll
157 reject variable names and the like. */
158 char *orig_arg
= arg
; /* decode_line_1 modifies the arg pointer. */
159 volatile struct gdb_exception decode_exception
;
160 struct symtabs_and_lines sals
= { 0 };
162 TRY_CATCH (decode_exception
, RETURN_MASK_ERROR
)
164 sals
= decode_line_1 (&arg
, DECODE_LINE_FUNFIRSTLINE
, 0, 0);
167 if (decode_exception
.reason
< 0)
169 if (decode_exception
.error
!= NOT_FOUND_ERROR
)
170 throw_exception (decode_exception
);
172 fprintf_filtered (gdb_stderr
,
173 _("No function found named %s.\n"), orig_arg
);
176 Ignore function pending future shared library load? ")))
178 /* Add the pending skiplist entry. */
179 skip_function_pc (0, orig_arg
, 0, 1);
186 error (_("Specify just one function at a time."));
187 if (strlen (arg
) != 0)
188 error (_("Junk at end of arguments."));
190 /* The pc decode_line_1 gives us is the first line of the function,
191 but we actually want the line before that. The call to
192 find_pc_partial_function gets us the value we actually want. */
194 struct symtab_and_line sal
= sals
.sals
[0];
195 CORE_ADDR pc
= sal
.pc
;
196 CORE_ADDR func_start
= 0;
197 struct gdbarch
*arch
= get_sal_arch (sal
);
199 if (!find_pc_partial_function (pc
, &name
, &func_start
, 0))
201 error (_("No function found containing program point %s."),
202 paddress (arch
, pc
));
205 skip_function_pc (func_start
, name
, arch
, 0);
211 skip_info (char *arg
, int from_tty
)
213 struct skiplist_entry
*e
;
214 int num_printable_entries
= 0;
215 int address_width
= 10;
216 struct value_print_options opts
;
217 struct cleanup
*tbl_chain
;
219 get_user_print_options (&opts
);
221 /* Count the number of rows in the table and see if we need space for a
222 64-bit address anywhere. */
223 ALL_SKIPLIST_ENTRIES (e
)
224 if (arg
== 0 || number_is_in_list (arg
, e
->number
))
226 num_printable_entries
++;
227 if (e
->gdbarch
&& gdbarch_addr_bit (e
->gdbarch
) > 32)
231 if (num_printable_entries
== 0)
234 ui_out_message (current_uiout
, 0, _("\
235 Not skipping any files or functions.\n"));
237 ui_out_message (current_uiout
, 0,
238 _("No skiplist entries found with number %s.\n"), arg
);
243 if (opts
.addressprint
)
244 tbl_chain
= make_cleanup_ui_out_table_begin_end (current_uiout
, 5,
245 num_printable_entries
,
249 = make_cleanup_ui_out_table_begin_end (current_uiout
, 4,
250 num_printable_entries
,
253 ui_out_table_header (current_uiout
, 7, ui_left
, "number", "Num"); /* 1 */
254 ui_out_table_header (current_uiout
, 14, ui_left
, "type", "Type"); /* 2 */
255 ui_out_table_header (current_uiout
, 3, ui_left
, "enabled", "Enb"); /* 3 */
256 if (opts
.addressprint
)
258 ui_out_table_header (current_uiout
, address_width
, ui_left
,
259 "addr", "Address"); /* 4 */
261 ui_out_table_header (current_uiout
, 40, ui_noalign
, "what", "What"); /* 5 */
262 ui_out_table_body (current_uiout
);
264 ALL_SKIPLIST_ENTRIES (e
)
266 struct cleanup
*entry_chain
;
269 if (arg
!= 0 && !number_is_in_list (arg
, e
->number
))
272 entry_chain
= make_cleanup_ui_out_tuple_begin_end (current_uiout
,
274 ui_out_field_int (current_uiout
, "number", e
->number
); /* 1 */
276 if (e
->function_name
!= 0)
277 ui_out_field_string (current_uiout
, "type", "function"); /* 2 */
278 else if (e
->filename
!= 0)
279 ui_out_field_string (current_uiout
, "type", "file"); /* 2 */
281 internal_error (__FILE__
, __LINE__
, _("\
282 Skiplist entry should have either a filename or a function name."));
285 ui_out_field_string (current_uiout
, "enabled", "y"); /* 3 */
287 ui_out_field_string (current_uiout
, "enabled", "n"); /* 3 */
289 if (opts
.addressprint
)
292 ui_out_field_core_addr (current_uiout
, "addr",
293 e
->gdbarch
, e
->pc
); /* 4 */
295 ui_out_field_string (current_uiout
, "addr", ""); /* 4 */
298 if (!e
->pending
&& e
->function_name
!= 0)
302 gdb_assert (e
->pc
!= 0);
303 sym
= find_pc_function (e
->pc
);
305 ui_out_field_fmt (current_uiout
, "what", "%s at %s:%d",
307 sym
->symtab
->filename
,
310 ui_out_field_string (current_uiout
, "what", "?");
312 else if (e
->pending
&& e
->function_name
!= 0)
314 ui_out_field_fmt (current_uiout
, "what", "%s (PENDING)",
317 else if (!e
->pending
&& e
->filename
!= 0)
318 ui_out_field_string (current_uiout
, "what", e
->filename
);
319 else if (e
->pending
&& e
->filename
!= 0)
320 ui_out_field_fmt (current_uiout
, "what", "%s (PENDING)",
323 ui_out_text (current_uiout
, "\n");
324 do_cleanups (entry_chain
);
327 do_cleanups (tbl_chain
);
331 skip_enable_command (char *arg
, int from_tty
)
333 struct skiplist_entry
*e
;
336 ALL_SKIPLIST_ENTRIES (e
)
337 if (arg
== 0 || number_is_in_list (arg
, e
->number
))
344 error (_("No skiplist entries found with number %s."), arg
);
348 skip_disable_command (char *arg
, int from_tty
)
350 struct skiplist_entry
*e
;
353 ALL_SKIPLIST_ENTRIES (e
)
354 if (arg
== 0 || number_is_in_list (arg
, e
->number
))
361 error (_("No skiplist entries found with number %s."), arg
);
365 skip_delete_command (char *arg
, int from_tty
)
367 struct skiplist_entry
*e
, *temp
, *b_prev
;
371 ALL_SKIPLIST_ENTRIES_SAFE (e
, temp
)
372 if (arg
== 0 || number_is_in_list (arg
, e
->number
))
375 b_prev
->next
= e
->next
;
377 skiplist_entry_chain
= e
->next
;
379 xfree (e
->function_name
);
390 error (_("No skiplist entries found with number %s."), arg
);
393 /* Create a skiplist entry for the given pc corresponding to the given
394 function name and add it to the list. */
397 skip_function_pc (CORE_ADDR pc
, const char *name
, struct gdbarch
*arch
,
400 struct skiplist_entry
*e
= XZALLOC (struct skiplist_entry
);
405 e
->pending
= pending
;
406 e
->function_name
= xstrdup (name
);
408 add_skiplist_entry (e
);
411 printf_filtered (_("Function %s at %s will be skipped when stepping.\n"),
412 name
, paddress (get_current_arch (), pc
));
414 printf_filtered (_("Function %s will be skipped when stepping, "
415 "pending shared library load.\n"),
419 /* Add the given skiplist entry to our list, and set the entry's number. */
422 add_skiplist_entry (struct skiplist_entry
*e
)
424 struct skiplist_entry
*e1
;
426 e
->number
= ++skiplist_entry_count
;
428 /* Add to the end of the chain so that the list of
429 skiplist entries will be in numerical order. */
431 e1
= skiplist_entry_chain
;
433 skiplist_entry_chain
= e
;
442 /* Does the given pc correspond to the beginning of a skipped function? */
445 function_pc_is_marked_for_skip (CORE_ADDR pc
)
447 int searched_for_sal
= 0;
448 struct symtab_and_line sal
;
449 char *filename
= NULL
;
450 struct skiplist_entry
*e
;
452 ALL_SKIPLIST_ENTRIES (e
)
454 if (!e
->enabled
|| e
->pending
)
457 /* Does the pc we're stepping into match e's stored pc? */
458 if (e
->pc
!= 0 && pc
== e
->pc
)
461 if (e
->filename
!= 0)
463 /* Get the filename corresponding to this pc, if we haven't
465 if (!searched_for_sal
)
467 sal
= find_pc_line (pc
, 0);
469 filename
= sal
.symtab
->filename
;
470 searched_for_sal
= 1;
472 if (filename
!= 0 && strcmp (filename
, e
->filename
) == 0)
480 /* Re-set the skip list after symbols have been re-loaded. */
484 struct skiplist_entry
*e
;
486 ALL_SKIPLIST_ENTRIES (e
)
488 if (e
->filename
!= 0)
490 /* If it's an entry telling us to skip a file, but the entry is
491 currently pending a solib load, let's see if we now know
493 struct symtab
*symtab
= lookup_symtab (e
->filename
);
497 e
->filename
= xstrdup (symtab
->filename
);
498 e
->gdbarch
= get_objfile_arch (symtab
->objfile
);
506 else if (e
->function_name
!= 0)
508 char *func_name
= e
->function_name
;
509 struct symtabs_and_lines sals
= { 0 };
510 volatile struct gdb_exception decode_exception
;
512 TRY_CATCH (decode_exception
, RETURN_MASK_ERROR
)
514 sals
= decode_line_1 (&func_name
, DECODE_LINE_FUNFIRSTLINE
, 0, 0);
517 if (decode_exception
.reason
>= 0
518 && sals
.nelts
== 1 && strlen (func_name
) == 0)
520 struct symtab_and_line sal
= sals
.sals
[0];
521 CORE_ADDR pc
= sal
.pc
;
522 CORE_ADDR func_start
= 0;
523 struct gdbarch
*arch
= get_sal_arch (sal
);
524 const char *func_name
;
526 if (find_pc_partial_function (pc
, &func_name
, &func_start
, 0))
529 e
->function_name
= xstrdup (func_name
);
542 /* Provide a prototype to silence -Wmissing-prototypes. */
543 extern initialize_file_ftype _initialize_step_skip
;
546 _initialize_step_skip (void)
548 struct cmd_list_element
*c
;
550 skiplist_entry_chain
= 0;
551 skiplist_entry_count
= 0;
553 add_prefix_cmd ("skip", class_breakpoint
, skip_function_command
, _("\
554 Ignore a function while stepping.\n\
555 Usage: skip [FUNCTION NAME]\n\
556 If no function name is given, ignore the current function."),
557 &skiplist
, "skip ", 1, &cmdlist
);
559 c
= add_cmd ("file", class_breakpoint
, skip_file_command
, _("\
560 Ignore a file while stepping.\n\
561 Usage: skip file [FILENAME]\n\
562 If no filename is given, ignore the current file."),
564 set_cmd_completer (c
, filename_completer
);
566 c
= add_cmd ("function", class_breakpoint
, skip_function_command
, _("\
567 Ignore a function while stepping.\n\
568 Usage: skip function [FUNCTION NAME]\n\
569 If no function name is given, skip the current function."),
571 set_cmd_completer (c
, location_completer
);
573 add_cmd ("enable", class_breakpoint
, skip_enable_command
, _("\
574 Enable skip entries. You can specify numbers (e.g. \"skip enable 1 3\"), \
575 ranges (e.g. \"skip enable 4-8\"), or both (e.g. \"skip enable 1 3 4-8\").\n\n\
576 If you don't specify any numbers or ranges, we'll enable all skip entries.\n\n\
577 Usage: skip enable [NUMBERS AND/OR RANGES]"),
580 add_cmd ("disable", class_breakpoint
, skip_disable_command
, _("\
581 Disable skip entries. You can specify numbers (e.g. \"skip disable 1 3\"), \
582 ranges (e.g. \"skip disable 4-8\"), or both (e.g. \"skip disable 1 3 4-8\").\n\n\
583 If you don't specify any numbers or ranges, we'll disable all skip entries.\n\n\
584 Usage: skip disable [NUMBERS AND/OR RANGES]"),
587 add_cmd ("delete", class_breakpoint
, skip_delete_command
, _("\
588 Delete skip entries. You can specify numbers (e.g. \"skip delete 1 3\"), \
589 ranges (e.g. \"skip delete 4-8\"), or both (e.g. \"skip delete 1 3 4-8\").\n\n\
590 If you don't specify any numbers or ranges, we'll delete all skip entries.\n\n\
591 Usage: skip delete [NUMBERS AND/OR RANGES]"),
594 add_info ("skip", skip_info
, _("\
595 Display the status of skips. You can specify numbers (e.g. \"skip info 1 3\"), \
596 ranges (e.g. \"skip info 4-8\"), or both (e.g. \"skip info 1 3 4-8\").\n\n\
597 If you don't specify any numbers or ranges, we'll show all skips.\n\n\
598 Usage: skip info [NUMBERS AND/OR RANGES]\n\
599 The \"Type\" column indicates one of:\n\
600 \tfile - ignored file\n\
601 \tfunction - ignored function"));