1 /* MI Command Set - breakpoint and watchpoint commands.
2 Copyright (C) 2000-2018 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions (a Red Hat company).
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/>. */
21 #include "arch-utils.h"
25 #include "breakpoint.h"
26 #include "mi-getopt.h"
27 #include "observable.h"
29 #include "mi-cmd-break.h"
33 #include "gdb_obstack.h"
35 #include "tracepoint.h"
42 /* True if MI breakpoint observers have been registered. */
44 static int mi_breakpoint_observers_installed;
46 /* Control whether breakpoint_notify may act. */
48 static int mi_can_breakpoint_notify;
50 /* Output a single breakpoint, when allowed. */
53 breakpoint_notify (struct breakpoint *b)
55 if (mi_can_breakpoint_notify)
61 CATCH (ex, RETURN_MASK_ALL)
63 exception_print (gdb_stderr, ex);
76 /* Arrange for all new breakpoints and catchpoints to be reported to
77 CURRENT_UIOUT until the destructor of the returned scoped_restore
80 Note that MI output will be probably invalid if more than one
81 breakpoint is created inside one MI command. */
83 scoped_restore_tmpl<int>
84 setup_breakpoint_reporting (void)
86 if (! mi_breakpoint_observers_installed)
88 gdb::observers::breakpoint_created.attach (breakpoint_notify);
89 mi_breakpoint_observers_installed = 1;
92 return make_scoped_restore (&mi_can_breakpoint_notify, 1);
96 /* Convert arguments in ARGV to the string in "format",argv,argv...
100 mi_argv_to_format (char **argv, int argc)
105 /* Convert ARGV[OIND + 1] to format string and save to FORMAT. */
107 for (i = 0; i < strlen (argv[0]); i++)
139 if (isprint (argv[0][i]))
140 result += argv[0][i];
145 xsnprintf (tmp, sizeof (tmp), "\\%o",
146 (unsigned char) argv[0][i]);
154 /* Apply other argv to FORMAT. */
155 for (i = 1; i < argc; i++)
164 /* Insert breakpoint.
165 If dprintf is true, it will insert dprintf.
166 If not, it will insert other type breakpoint. */
169 mi_cmd_break_insert_1 (int dprintf, const char *command, char **argv, int argc)
171 const char *address = NULL;
175 int ignore_count = 0;
176 char *condition = NULL;
180 enum bptype type_wanted;
181 event_location_up location;
182 struct breakpoint_ops *ops;
184 struct explicit_location explicit_loc;
185 std::string extra_string;
189 HARDWARE_OPT, TEMP_OPT, CONDITION_OPT,
190 IGNORE_COUNT_OPT, THREAD_OPT, PENDING_OPT, DISABLE_OPT,
192 EXPLICIT_SOURCE_OPT, EXPLICIT_FUNC_OPT,
193 EXPLICIT_LABEL_OPT, EXPLICIT_LINE_OPT
195 static const struct mi_opt opts[] =
197 {"h", HARDWARE_OPT, 0},
199 {"c", CONDITION_OPT, 1},
200 {"i", IGNORE_COUNT_OPT, 1},
201 {"p", THREAD_OPT, 1},
202 {"f", PENDING_OPT, 0},
203 {"d", DISABLE_OPT, 0},
204 {"a", TRACEPOINT_OPT, 0},
205 {"-source" , EXPLICIT_SOURCE_OPT, 1},
206 {"-function", EXPLICIT_FUNC_OPT, 1},
207 {"-label", EXPLICIT_LABEL_OPT, 1},
208 {"-line", EXPLICIT_LINE_OPT, 1},
212 /* Parse arguments. It could be -r or -h or -t, <location> or ``--''
213 to denote the end of the option list. */
217 initialize_explicit_location (&explicit_loc);
221 int opt = mi_getopt ("-break-insert", argc, argv,
225 switch ((enum opt) opt)
236 case IGNORE_COUNT_OPT:
237 ignore_count = atol (oarg);
240 thread = atol (oarg);
251 case EXPLICIT_SOURCE_OPT:
253 explicit_loc.source_filename = oarg;
255 case EXPLICIT_FUNC_OPT:
257 explicit_loc.function_name = oarg;
259 case EXPLICIT_LABEL_OPT:
261 explicit_loc.label_name = oarg;
263 case EXPLICIT_LINE_OPT:
265 explicit_loc.line_offset = linespec_parse_line_offset (oarg);
270 if (oind >= argc && !is_explicit)
271 error (_("-%s-insert: Missing <location>"),
272 dprintf ? "dprintf" : "break");
275 int format_num = is_explicit ? oind : oind + 1;
277 if (hardware || tracepoint)
278 error (_("-dprintf-insert: does not support -h or -a"));
279 if (format_num >= argc)
280 error (_("-dprintf-insert: Missing <format>"));
282 extra_string = mi_argv_to_format (argv + format_num, argc - format_num);
283 address = argv[oind];
290 error (_("-break-insert: Garbage following explicit location"));
295 error (_("-break-insert: Garbage following <location>"));
296 address = argv[oind];
300 /* Now we have what we need, let's insert the breakpoint! */
301 scoped_restore restore_breakpoint_reporting = setup_breakpoint_reporting ();
305 /* Note that to request a fast tracepoint, the client uses the
306 "hardware" flag, although there's nothing of hardware related to
307 fast tracepoints -- one can implement slow tracepoints with
308 hardware breakpoints, but fast tracepoints are always software.
309 "fast" is a misnomer, actually, "jump" would be more appropriate.
310 A simulator or an emulator could conceivably implement fast
311 regular non-jump based tracepoints. */
312 type_wanted = hardware ? bp_fast_tracepoint : bp_tracepoint;
313 ops = &tracepoint_breakpoint_ops;
317 type_wanted = bp_dprintf;
318 ops = &dprintf_breakpoint_ops;
322 type_wanted = hardware ? bp_hardware_breakpoint : bp_breakpoint;
323 ops = &bkpt_breakpoint_ops;
328 /* Error check -- we must have one of the other
329 parameters specified. */
330 if (explicit_loc.source_filename != NULL
331 && explicit_loc.function_name == NULL
332 && explicit_loc.label_name == NULL
333 && explicit_loc.line_offset.sign == LINE_OFFSET_UNKNOWN)
334 error (_("-%s-insert: --source option requires --function, --label,"
335 " or --line"), dprintf ? "dprintf" : "break");
337 location = new_explicit_location (&explicit_loc);
341 location = string_to_event_location_basic (&address, current_language,
342 symbol_name_match_type::WILD);
344 error (_("Garbage '%s' at end of location"), address);
347 create_breakpoint (get_current_arch (), location.get (), condition, thread,
348 extra_string.c_str (),
349 0 /* condition and thread are valid. */,
352 pending ? AUTO_BOOLEAN_TRUE : AUTO_BOOLEAN_FALSE,
353 ops, 0, enabled, 0, 0);
356 /* Implements the -break-insert command.
357 See the MI manual for the list of possible options. */
360 mi_cmd_break_insert (const char *command, char **argv, int argc)
362 mi_cmd_break_insert_1 (0, command, argv, argc);
365 /* Implements the -dprintf-insert command.
366 See the MI manual for the list of possible options. */
369 mi_cmd_dprintf_insert (const char *command, char **argv, int argc)
371 mi_cmd_break_insert_1 (1, command, argv, argc);
382 mi_cmd_break_passcount (const char *command, char **argv, int argc)
386 struct tracepoint *t;
389 error (_("Usage: tracepoint-number passcount"));
393 t = get_tracepoint (n);
398 gdb::observers::breakpoint_modified.notify (t);
402 error (_("Could not find tracepoint %d"), n);
406 /* Insert a watchpoint. The type of watchpoint is specified by the
408 -break-watch <expr> --> insert a regular wp.
409 -break-watch -r <expr> --> insert a read watchpoint.
410 -break-watch -a <expr> --> insert an access wp. */
413 mi_cmd_break_watch (const char *command, char **argv, int argc)
416 enum wp_type type = REG_WP;
421 static const struct mi_opt opts[] =
424 {"a", ACCESS_OPT, 0},
428 /* Parse arguments. */
434 int opt = mi_getopt ("-break-watch", argc, argv,
439 switch ((enum opt) opt)
450 error (_("-break-watch: Missing <expression>"));
452 error (_("-break-watch: Garbage following <expression>"));
455 /* Now we have what we need, let's insert the watchpoint! */
459 watch_command_wrapper (expr, FROM_TTY, 0);
462 rwatch_command_wrapper (expr, FROM_TTY, 0);
465 awatch_command_wrapper (expr, FROM_TTY, 0);
468 error (_("-break-watch: Unknown watchpoint type."));
473 mi_cmd_break_commands (const char *command, char **argv, int argc)
475 counted_command_line break_command;
478 struct breakpoint *b;
481 error (_("USAGE: %s <BKPT> [<COMMAND> [<COMMAND>...]]"), command);
483 bnum = strtol (argv[0], &endptr, 0);
484 if (endptr == argv[0])
485 error (_("breakpoint number argument \"%s\" is not a number."),
487 else if (*endptr != '\0')
488 error (_("junk at the end of breakpoint number argument \"%s\"."),
491 b = get_breakpoint (bnum);
493 error (_("breakpoint %d not found."), bnum);
499 const char *result = nullptr;
501 result = argv[count++];
505 if (is_tracepoint (b))
506 break_command = read_command_lines_1 (reader, 1,
507 [=] (const char *line)
509 validate_actionline (line, b);
512 break_command = read_command_lines_1 (reader, 1, 0);
514 breakpoint_set_commands (b, std::move (break_command));