96c5feafb1aefbae03087894514548fba7107cc5
[binutils-gdb.git] / gdb / infcmd.c
1 /* Memory-access and commands for "inferior" process, for GDB.
2
3 Copyright (C) 1986-2023 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #include "defs.h"
21 #include "arch-utils.h"
22 #include "symtab.h"
23 #include "gdbtypes.h"
24 #include "frame.h"
25 #include "inferior.h"
26 #include "infrun.h"
27 #include "gdbsupport/environ.h"
28 #include "value.h"
29 #include "gdbcmd.h"
30 #include "symfile.h"
31 #include "gdbcore.h"
32 #include "target.h"
33 #include "language.h"
34 #include "objfiles.h"
35 #include "completer.h"
36 #include "ui-out.h"
37 #include "regcache.h"
38 #include "reggroups.h"
39 #include "block.h"
40 #include "solib.h"
41 #include <ctype.h>
42 #include "observable.h"
43 #include "target-descriptions.h"
44 #include "user-regs.h"
45 #include "gdbthread.h"
46 #include "valprint.h"
47 #include "inline-frame.h"
48 #include "tracepoint.h"
49 #include "inf-loop.h"
50 #include "linespec.h"
51 #include "thread-fsm.h"
52 #include "ui.h"
53 #include "interps.h"
54 #include "skip.h"
55 #include "gdbsupport/gdb_optional.h"
56 #include "source.h"
57 #include "cli/cli-style.h"
58 #include "dwarf2/loc.h"
59
60 /* Local functions: */
61
62 static void until_next_command (int);
63
64 static void step_1 (int, int, const char *);
65
66 #define ERROR_NO_INFERIOR \
67 if (!target_has_execution ()) error (_("The program is not being run."));
68
69 /* Pid of our debugged inferior, or 0 if no inferior now.
70 Since various parts of infrun.c test this to see whether there is a program
71 being debugged it should be nonzero (currently 3 is used) for remote
72 debugging. */
73
74 ptid_t inferior_ptid;
75
76 /* Nonzero if stopped due to completion of a stack dummy routine. */
77
78 enum stop_stack_kind stop_stack_dummy;
79
80 /* Nonzero if stopped due to a random (unexpected) signal in inferior
81 process. */
82
83 int stopped_by_random_signal;
84
85
86 /* Whether "finish" should print the value. */
87
88 static bool finish_print = true;
89
90 \f
91
92 /* Store the new value passed to 'set inferior-tty'. */
93
94 static void
95 set_tty_value (const std::string &tty)
96 {
97 current_inferior ()->set_tty (tty);
98 }
99
100 /* Get the current 'inferior-tty' value. */
101
102 static const std::string &
103 get_tty_value ()
104 {
105 return current_inferior ()->tty ();
106 }
107
108 /* Implement 'show inferior-tty' command. */
109
110 static void
111 show_inferior_tty_command (struct ui_file *file, int from_tty,
112 struct cmd_list_element *c, const char *value)
113 {
114 /* Note that we ignore the passed-in value in favor of computing it
115 directly. */
116 const std::string &inferior_tty = current_inferior ()->tty ();
117
118 gdb_printf (file,
119 _("Terminal for future runs of program being debugged "
120 "is \"%s\".\n"), inferior_tty.c_str ());
121 }
122
123 /* Store the new value passed to 'set args'. */
124
125 static void
126 set_args_value (const std::string &args)
127 {
128 current_inferior ()->set_args (args);
129 }
130
131 /* Return the value for 'show args' to display. */
132
133 static const std::string &
134 get_args_value ()
135 {
136 return current_inferior ()->args ();
137 }
138
139 /* Callback to implement 'show args' command. */
140
141 static void
142 show_args_command (struct ui_file *file, int from_tty,
143 struct cmd_list_element *c, const char *value)
144 {
145 /* Ignore the passed in value, pull the argument directly from the
146 inferior. However, these should always be the same. */
147 gdb_printf (file, _("\
148 Argument list to give program being debugged when it is started is \"%s\".\n"),
149 current_inferior ()->args ().c_str ());
150 }
151
152 /* See gdbsupport/common-inferior.h. */
153
154 const std::string &
155 get_inferior_cwd ()
156 {
157 return current_inferior ()->cwd ();
158 }
159
160 /* Store the new value passed to 'set cwd'. */
161
162 static void
163 set_cwd_value (const std::string &args)
164 {
165 current_inferior ()->set_cwd (args);
166 }
167
168 /* Handle the 'show cwd' command. */
169
170 static void
171 show_cwd_command (struct ui_file *file, int from_tty,
172 struct cmd_list_element *c, const char *value)
173 {
174 const std::string &cwd = current_inferior ()->cwd ();
175
176 if (cwd.empty ())
177 gdb_printf (file,
178 _("\
179 You have not set the inferior's current working directory.\n\
180 The inferior will inherit GDB's cwd if native debugging, or the remote\n\
181 server's cwd if remote debugging.\n"));
182 else
183 gdb_printf (file,
184 _("Current working directory that will be used "
185 "when starting the inferior is \"%s\".\n"),
186 cwd.c_str ());
187 }
188
189
190 /* This function strips the '&' character (indicating background
191 execution) that is added as *the last* of the arguments ARGS of a
192 command. A copy of the incoming ARGS without the '&' is returned,
193 unless the resulting string after stripping is empty, in which case
194 NULL is returned. *BG_CHAR_P is an output boolean that indicates
195 whether the '&' character was found. */
196
197 static gdb::unique_xmalloc_ptr<char>
198 strip_bg_char (const char *args, int *bg_char_p)
199 {
200 const char *p;
201
202 if (args == nullptr || *args == '\0')
203 {
204 *bg_char_p = 0;
205 return nullptr;
206 }
207
208 p = args + strlen (args);
209 if (p[-1] == '&')
210 {
211 p--;
212 while (p > args && isspace (p[-1]))
213 p--;
214
215 *bg_char_p = 1;
216 if (p != args)
217 return gdb::unique_xmalloc_ptr<char>
218 (savestring (args, p - args));
219 else
220 return gdb::unique_xmalloc_ptr<char> (nullptr);
221 }
222
223 *bg_char_p = 0;
224 return make_unique_xstrdup (args);
225 }
226
227 /* Common actions to take after creating any sort of inferior, by any
228 means (running, attaching, connecting, et cetera). The target
229 should be stopped. */
230
231 void
232 post_create_inferior (int from_tty)
233 {
234
235 /* Be sure we own the terminal in case write operations are performed. */
236 target_terminal::ours_for_output ();
237
238 infrun_debug_show_threads ("threads in the newly created inferior",
239 current_inferior ()->non_exited_threads ());
240
241 /* If the target hasn't taken care of this already, do it now.
242 Targets which need to access registers during to_open,
243 to_create_inferior, or to_attach should do it earlier; but many
244 don't need to. */
245 target_find_description ();
246
247 /* Now that we know the register layout, retrieve current PC. But
248 if the PC is unavailable (e.g., we're opening a core file with
249 missing registers info), ignore it. */
250 thread_info *thr = inferior_thread ();
251
252 thr->clear_stop_pc ();
253 try
254 {
255 regcache *rc = get_thread_regcache (thr);
256 thr->set_stop_pc (regcache_read_pc (rc));
257 }
258 catch (const gdb_exception_error &ex)
259 {
260 if (ex.error != NOT_AVAILABLE_ERROR)
261 throw;
262 }
263
264 if (current_program_space->exec_bfd ())
265 {
266 const unsigned solib_add_generation
267 = current_program_space->solib_add_generation;
268
269 scoped_restore restore_in_initial_library_scan
270 = make_scoped_restore (&current_inferior ()->in_initial_library_scan,
271 true);
272
273 /* Create the hooks to handle shared library load and unload
274 events. */
275 solib_create_inferior_hook (from_tty);
276
277 if (current_program_space->solib_add_generation == solib_add_generation)
278 {
279 /* The platform-specific hook should load initial shared libraries,
280 but didn't. FROM_TTY will be incorrectly 0 but such solib
281 targets should be fixed anyway. Call it only after the solib
282 target has been initialized by solib_create_inferior_hook. */
283
284 if (info_verbose)
285 warning (_("platform-specific solib_create_inferior_hook did "
286 "not load initial shared libraries."));
287
288 /* If the solist is global across processes, there's no need to
289 refetch it here. */
290 if (!gdbarch_has_global_solist (target_gdbarch ()))
291 solib_add (nullptr, 0, auto_solib_add);
292 }
293 }
294
295 /* If the user sets watchpoints before execution having started,
296 then she gets software watchpoints, because GDB can't know which
297 target will end up being pushed, or if it supports hardware
298 watchpoints or not. breakpoint_re_set takes care of promoting
299 watchpoints to hardware watchpoints if possible, however, if this
300 new inferior doesn't load shared libraries or we don't pull in
301 symbols from any other source on this target/arch,
302 breakpoint_re_set is never called. Call it now so that software
303 watchpoints get a chance to be promoted to hardware watchpoints
304 if the now pushed target supports hardware watchpoints. */
305 breakpoint_re_set ();
306
307 gdb::observers::inferior_created.notify (current_inferior ());
308 }
309
310 /* Kill the inferior if already running. This function is designed
311 to be called when we are about to start the execution of the program
312 from the beginning. Ask the user to confirm that he wants to restart
313 the program being debugged when FROM_TTY is non-null. */
314
315 static void
316 kill_if_already_running (int from_tty)
317 {
318 if (inferior_ptid != null_ptid && target_has_execution ())
319 {
320 /* Bail out before killing the program if we will not be able to
321 restart it. */
322 target_require_runnable ();
323
324 if (from_tty
325 && !query (_("The program being debugged has been started already.\n\
326 Start it from the beginning? ")))
327 error (_("Program not restarted."));
328 target_kill ();
329 }
330 }
331
332 /* See inferior.h. */
333
334 void
335 prepare_execution_command (struct target_ops *target, int background)
336 {
337 /* If we get a request for running in the bg but the target
338 doesn't support it, error out. */
339 if (background && !target_can_async_p (target))
340 error (_("Asynchronous execution not supported on this target."));
341
342 if (!background)
343 {
344 /* If we get a request for running in the fg, then we need to
345 simulate synchronous (fg) execution. Note no cleanup is
346 necessary for this. stdin is re-enabled whenever an error
347 reaches the top level. */
348 all_uis_on_sync_execution_starting ();
349 }
350 }
351
352 /* Determine how the new inferior will behave. */
353
354 enum run_how
355 {
356 /* Run program without any explicit stop during startup. */
357 RUN_NORMAL,
358
359 /* Stop at the beginning of the program's main function. */
360 RUN_STOP_AT_MAIN,
361
362 /* Stop at the first instruction of the program. */
363 RUN_STOP_AT_FIRST_INSN
364 };
365
366 /* Implement the "run" command. Force a stop during program start if
367 requested by RUN_HOW. */
368
369 static void
370 run_command_1 (const char *args, int from_tty, enum run_how run_how)
371 {
372 const char *exec_file;
373 struct ui_out *uiout = current_uiout;
374 struct target_ops *run_target;
375 int async_exec;
376
377 dont_repeat ();
378
379 scoped_disable_commit_resumed disable_commit_resumed ("running");
380
381 kill_if_already_running (from_tty);
382
383 init_wait_for_inferior ();
384 clear_breakpoint_hit_counts ();
385
386 /* Clean up any leftovers from other runs. Some other things from
387 this function should probably be moved into target_pre_inferior. */
388 target_pre_inferior (from_tty);
389
390 /* The comment here used to read, "The exec file is re-read every
391 time we do a generic_mourn_inferior, so we just have to worry
392 about the symbol file." The `generic_mourn_inferior' function
393 gets called whenever the program exits. However, suppose the
394 program exits, and *then* the executable file changes? We need
395 to check again here. Since reopen_exec_file doesn't do anything
396 if the timestamp hasn't changed, I don't see the harm. */
397 reopen_exec_file ();
398 reread_symbols (from_tty);
399
400 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (args, &async_exec);
401 args = stripped.get ();
402
403 /* Do validation and preparation before possibly changing anything
404 in the inferior. */
405
406 run_target = find_run_target ();
407
408 prepare_execution_command (run_target, async_exec);
409
410 if (non_stop && !run_target->supports_non_stop ())
411 error (_("The target does not support running in non-stop mode."));
412
413 /* Done. Can now set breakpoints, change inferior args, etc. */
414
415 /* Insert temporary breakpoint in main function if requested. */
416 if (run_how == RUN_STOP_AT_MAIN)
417 {
418 /* To avoid other inferiors hitting this breakpoint, make it
419 inferior-specific using a condition. A better solution would be to
420 have proper inferior-specific breakpoint support, in the breakpoint
421 machinery. We could then avoid inserting a breakpoint in the program
422 spaces unrelated to this inferior. */
423 const char *op
424 = ((current_language->la_language == language_ada
425 || current_language->la_language == language_pascal
426 || current_language->la_language == language_m2) ? "=" : "==");
427 std::string arg = string_printf
428 ("-qualified %s if $_inferior %s %d", main_name (), op,
429 current_inferior ()->num);
430 tbreak_command (arg.c_str (), 0);
431 }
432
433 exec_file = get_exec_file (0);
434
435 /* We keep symbols from add-symbol-file, on the grounds that the
436 user might want to add some symbols before running the program
437 (right?). But sometimes (dynamic loading where the user manually
438 introduces the new symbols with add-symbol-file), the code which
439 the symbols describe does not persist between runs. Currently
440 the user has to manually nuke all symbols between runs if they
441 want them to go away (PR 2207). This is probably reasonable. */
442
443 /* If there were other args, beside '&', process them. */
444 if (args != nullptr)
445 current_inferior ()->set_args (args);
446
447 if (from_tty)
448 {
449 uiout->field_string (nullptr, "Starting program");
450 uiout->text (": ");
451 if (exec_file)
452 uiout->field_string ("execfile", exec_file,
453 file_name_style.style ());
454 uiout->spaces (1);
455 uiout->field_string ("infargs", current_inferior ()->args ());
456 uiout->text ("\n");
457 uiout->flush ();
458 }
459
460 run_target->create_inferior (exec_file,
461 current_inferior ()->args (),
462 current_inferior ()->environment.envp (),
463 from_tty);
464 /* to_create_inferior should push the target, so after this point we
465 shouldn't refer to run_target again. */
466 run_target = nullptr;
467
468 infrun_debug_show_threads ("immediately after create_process",
469 current_inferior ()->non_exited_threads ());
470
471 /* We're starting off a new process. When we get out of here, in
472 non-stop mode, finish the state of all threads of that process,
473 but leave other threads alone, as they may be stopped in internal
474 events --- the frontend shouldn't see them as stopped. In
475 all-stop, always finish the state of all threads, as we may be
476 resuming more than just the new process. */
477 process_stratum_target *finish_target;
478 ptid_t finish_ptid;
479 if (non_stop)
480 {
481 finish_target = current_inferior ()->process_target ();
482 finish_ptid = ptid_t (current_inferior ()->pid);
483 }
484 else
485 {
486 finish_target = nullptr;
487 finish_ptid = minus_one_ptid;
488 }
489 scoped_finish_thread_state finish_state (finish_target, finish_ptid);
490
491 /* Pass zero for FROM_TTY, because at this point the "run" command
492 has done its thing; now we are setting up the running program. */
493 post_create_inferior (0);
494
495 /* Queue a pending event so that the program stops immediately. */
496 if (run_how == RUN_STOP_AT_FIRST_INSN)
497 {
498 thread_info *thr = inferior_thread ();
499 target_waitstatus ws;
500 ws.set_stopped (GDB_SIGNAL_0);
501 thr->set_pending_waitstatus (ws);
502 }
503
504 /* Start the target running. Do not use -1 continuation as it would skip
505 breakpoint right at the entry point. */
506 proceed (regcache_read_pc (get_current_regcache ()), GDB_SIGNAL_0);
507
508 /* Since there was no error, there's no need to finish the thread
509 states here. */
510 finish_state.release ();
511
512 disable_commit_resumed.reset_and_commit ();
513 }
514
515 static void
516 run_command (const char *args, int from_tty)
517 {
518 run_command_1 (args, from_tty, RUN_NORMAL);
519 }
520
521 /* Start the execution of the program up until the beginning of the main
522 program. */
523
524 static void
525 start_command (const char *args, int from_tty)
526 {
527 /* Some languages such as Ada need to search inside the program
528 minimal symbols for the location where to put the temporary
529 breakpoint before starting. */
530 if (!have_minimal_symbols ())
531 error (_("No symbol table loaded. Use the \"file\" command."));
532
533 /* Run the program until reaching the main procedure... */
534 run_command_1 (args, from_tty, RUN_STOP_AT_MAIN);
535 }
536
537 /* Start the execution of the program stopping at the first
538 instruction. */
539
540 static void
541 starti_command (const char *args, int from_tty)
542 {
543 run_command_1 (args, from_tty, RUN_STOP_AT_FIRST_INSN);
544 }
545
546 static int
547 proceed_thread_callback (struct thread_info *thread, void *arg)
548 {
549 /* We go through all threads individually instead of compressing
550 into a single target `resume_all' request, because some threads
551 may be stopped in internal breakpoints/events, or stopped waiting
552 for its turn in the displaced stepping queue (that is, they are
553 running && !executing). The target side has no idea about why
554 the thread is stopped, so a `resume_all' command would resume too
555 much. If/when GDB gains a way to tell the target `hold this
556 thread stopped until I say otherwise', then we can optimize
557 this. */
558 if (thread->state != THREAD_STOPPED)
559 return 0;
560
561 if (!thread->inf->has_execution ())
562 return 0;
563
564 switch_to_thread (thread);
565 clear_proceed_status (0);
566 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
567 return 0;
568 }
569
570 static void
571 ensure_valid_thread (void)
572 {
573 if (inferior_ptid == null_ptid
574 || inferior_thread ()->state == THREAD_EXITED)
575 error (_("Cannot execute this command without a live selected thread."));
576 }
577
578 /* If the user is looking at trace frames, any resumption of execution
579 is likely to mix up recorded and live target data. So simply
580 disallow those commands. */
581
582 static void
583 ensure_not_tfind_mode (void)
584 {
585 if (get_traceframe_number () >= 0)
586 error (_("Cannot execute this command while looking at trace frames."));
587 }
588
589 /* Throw an error indicating the current thread is running. */
590
591 static void
592 error_is_running (void)
593 {
594 error (_("Cannot execute this command while "
595 "the selected thread is running."));
596 }
597
598 /* Calls error_is_running if the current thread is running. */
599
600 static void
601 ensure_not_running (void)
602 {
603 if (inferior_thread ()->state == THREAD_RUNNING)
604 error_is_running ();
605 }
606
607 void
608 continue_1 (int all_threads)
609 {
610 ERROR_NO_INFERIOR;
611 ensure_not_tfind_mode ();
612
613 if (non_stop && all_threads)
614 {
615 /* Don't error out if the current thread is running, because
616 there may be other stopped threads. */
617
618 /* Backup current thread and selected frame and restore on scope
619 exit. */
620 scoped_restore_current_thread restore_thread;
621 scoped_disable_commit_resumed disable_commit_resumed
622 ("continue all threads in non-stop");
623
624 iterate_over_threads (proceed_thread_callback, nullptr);
625
626 if (current_ui->prompt_state == PROMPT_BLOCKED)
627 {
628 /* If all threads in the target were already running,
629 proceed_thread_callback ends up never calling proceed,
630 and so nothing calls this to put the inferior's terminal
631 settings in effect and remove stdin from the event loop,
632 which we must when running a foreground command. E.g.:
633
634 (gdb) c -a&
635 Continuing.
636 <all threads are running now>
637 (gdb) c -a
638 Continuing.
639 <no thread was resumed, but the inferior now owns the terminal>
640 */
641 target_terminal::inferior ();
642 }
643
644 disable_commit_resumed.reset_and_commit ();
645 }
646 else
647 {
648 ensure_valid_thread ();
649 ensure_not_running ();
650 clear_proceed_status (0);
651 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
652 }
653 }
654
655 /* continue [-a] [proceed-count] [&] */
656
657 static void
658 continue_command (const char *args, int from_tty)
659 {
660 int async_exec;
661 bool all_threads_p = false;
662
663 ERROR_NO_INFERIOR;
664
665 /* Find out whether we must run in the background. */
666 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (args, &async_exec);
667 args = stripped.get ();
668
669 if (args != nullptr)
670 {
671 if (startswith (args, "-a"))
672 {
673 all_threads_p = true;
674 args += sizeof ("-a") - 1;
675 if (*args == '\0')
676 args = nullptr;
677 }
678 }
679
680 if (!non_stop && all_threads_p)
681 error (_("`-a' is meaningless in all-stop mode."));
682
683 if (args != nullptr && all_threads_p)
684 error (_("Can't resume all threads and specify "
685 "proceed count simultaneously."));
686
687 /* If we have an argument left, set proceed count of breakpoint we
688 stopped at. */
689 if (args != nullptr)
690 {
691 bpstat *bs = nullptr;
692 int num, stat;
693 int stopped = 0;
694 struct thread_info *tp;
695
696 if (non_stop)
697 tp = inferior_thread ();
698 else
699 {
700 process_stratum_target *last_target;
701 ptid_t last_ptid;
702
703 get_last_target_status (&last_target, &last_ptid, nullptr);
704 tp = last_target->find_thread (last_ptid);
705 }
706 if (tp != nullptr)
707 bs = tp->control.stop_bpstat;
708
709 while ((stat = bpstat_num (&bs, &num)) != 0)
710 if (stat > 0)
711 {
712 set_ignore_count (num,
713 parse_and_eval_long (args) - 1,
714 from_tty);
715 /* set_ignore_count prints a message ending with a period.
716 So print two spaces before "Continuing.". */
717 if (from_tty)
718 gdb_printf (" ");
719 stopped = 1;
720 }
721
722 if (!stopped && from_tty)
723 {
724 gdb_printf
725 ("Not stopped at any breakpoint; argument ignored.\n");
726 }
727 }
728
729 ensure_not_tfind_mode ();
730
731 if (!non_stop || !all_threads_p)
732 {
733 ensure_valid_thread ();
734 ensure_not_running ();
735 }
736
737 prepare_execution_command (current_inferior ()->top_target (), async_exec);
738
739 if (from_tty)
740 gdb_printf (_("Continuing.\n"));
741
742 continue_1 (all_threads_p);
743 }
744 \f
745 /* Record in TP the starting point of a "step" or "next" command. */
746
747 static void
748 set_step_frame (thread_info *tp)
749 {
750 /* This can be removed once this function no longer implicitly relies on the
751 inferior_ptid value. */
752 gdb_assert (inferior_ptid == tp->ptid);
753
754 frame_info_ptr frame = get_current_frame ();
755
756 symtab_and_line sal = find_frame_sal (frame);
757 set_step_info (tp, frame, sal);
758
759 CORE_ADDR pc = get_frame_pc (frame);
760 tp->control.step_start_function = find_pc_function (pc);
761 }
762
763 /* Step until outside of current statement. */
764
765 static void
766 step_command (const char *count_string, int from_tty)
767 {
768 step_1 (0, 0, count_string);
769 }
770
771 /* Likewise, but skip over subroutine calls as if single instructions. */
772
773 static void
774 next_command (const char *count_string, int from_tty)
775 {
776 step_1 (1, 0, count_string);
777 }
778
779 /* Likewise, but step only one instruction. */
780
781 static void
782 stepi_command (const char *count_string, int from_tty)
783 {
784 step_1 (0, 1, count_string);
785 }
786
787 static void
788 nexti_command (const char *count_string, int from_tty)
789 {
790 step_1 (1, 1, count_string);
791 }
792
793 /* Data for the FSM that manages the step/next/stepi/nexti
794 commands. */
795
796 struct step_command_fsm : public thread_fsm
797 {
798 /* How many steps left in a "step N"-like command. */
799 int count;
800
801 /* If true, this is a next/nexti, otherwise a step/stepi. */
802 int skip_subroutines;
803
804 /* If true, this is a stepi/nexti, otherwise a step/step. */
805 int single_inst;
806
807 explicit step_command_fsm (struct interp *cmd_interp)
808 : thread_fsm (cmd_interp)
809 {
810 }
811
812 void clean_up (struct thread_info *thread) override;
813 bool should_stop (struct thread_info *thread) override;
814 enum async_reply_reason do_async_reply_reason () override;
815 };
816
817 /* Prepare for a step/next/etc. command. Any target resource
818 allocated here is undone in the FSM's clean_up method. */
819
820 static void
821 step_command_fsm_prepare (struct step_command_fsm *sm,
822 int skip_subroutines, int single_inst,
823 int count, struct thread_info *thread)
824 {
825 sm->skip_subroutines = skip_subroutines;
826 sm->single_inst = single_inst;
827 sm->count = count;
828
829 /* Leave the si command alone. */
830 if (!sm->single_inst || sm->skip_subroutines)
831 set_longjmp_breakpoint (thread, get_frame_id (get_current_frame ()));
832
833 thread->control.stepping_command = 1;
834 }
835
836 static int prepare_one_step (thread_info *, struct step_command_fsm *sm);
837
838 static void
839 step_1 (int skip_subroutines, int single_inst, const char *count_string)
840 {
841 int count;
842 int async_exec;
843 struct thread_info *thr;
844 struct step_command_fsm *step_sm;
845
846 ERROR_NO_INFERIOR;
847 ensure_not_tfind_mode ();
848 ensure_valid_thread ();
849 ensure_not_running ();
850
851 gdb::unique_xmalloc_ptr<char> stripped
852 = strip_bg_char (count_string, &async_exec);
853 count_string = stripped.get ();
854
855 prepare_execution_command (current_inferior ()->top_target (), async_exec);
856
857 count = count_string ? parse_and_eval_long (count_string) : 1;
858
859 clear_proceed_status (1);
860
861 /* Setup the execution command state machine to handle all the COUNT
862 steps. */
863 thr = inferior_thread ();
864 step_sm = new step_command_fsm (command_interp ());
865 thr->set_thread_fsm (std::unique_ptr<thread_fsm> (step_sm));
866
867 step_command_fsm_prepare (step_sm, skip_subroutines,
868 single_inst, count, thr);
869
870 /* Do only one step for now, before returning control to the event
871 loop. Let the continuation figure out how many other steps we
872 need to do, and handle them one at the time, through
873 step_once. */
874 if (!prepare_one_step (thr, step_sm))
875 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
876 else
877 {
878 /* Stepped into an inline frame. Pretend that we've
879 stopped. */
880 thr->thread_fsm ()->clean_up (thr);
881 bool proceeded = normal_stop ();
882 if (!proceeded)
883 inferior_event_handler (INF_EXEC_COMPLETE);
884 all_uis_check_sync_execution_done ();
885 }
886 }
887
888 /* Implementation of the 'should_stop' FSM method for stepping
889 commands. Called after we are done with one step operation, to
890 check whether we need to step again, before we print the prompt and
891 return control to the user. If count is > 1, returns false, as we
892 will need to keep going. */
893
894 bool
895 step_command_fsm::should_stop (struct thread_info *tp)
896 {
897 if (tp->control.stop_step)
898 {
899 /* There are more steps to make, and we did stop due to
900 ending a stepping range. Do another step. */
901 if (--count > 0)
902 return prepare_one_step (tp, this);
903
904 set_finished ();
905 }
906
907 return true;
908 }
909
910 /* Implementation of the 'clean_up' FSM method for stepping commands. */
911
912 void
913 step_command_fsm::clean_up (struct thread_info *thread)
914 {
915 if (!single_inst || skip_subroutines)
916 delete_longjmp_breakpoint (thread->global_num);
917 }
918
919 /* Implementation of the 'async_reply_reason' FSM method for stepping
920 commands. */
921
922 enum async_reply_reason
923 step_command_fsm::do_async_reply_reason ()
924 {
925 return EXEC_ASYNC_END_STEPPING_RANGE;
926 }
927
928 /* Prepare for one step in "step N". The actual target resumption is
929 done by the caller. Return true if we're done and should thus
930 report a stop to the user. Returns false if the target needs to be
931 resumed. */
932
933 static int
934 prepare_one_step (thread_info *tp, struct step_command_fsm *sm)
935 {
936 /* This can be removed once this function no longer implicitly relies on the
937 inferior_ptid value. */
938 gdb_assert (inferior_ptid == tp->ptid);
939
940 if (sm->count > 0)
941 {
942 frame_info_ptr frame = get_current_frame ();
943
944 set_step_frame (tp);
945
946 if (!sm->single_inst)
947 {
948 CORE_ADDR pc;
949
950 /* Step at an inlined function behaves like "down". */
951 if (!sm->skip_subroutines
952 && inline_skipped_frames (tp))
953 {
954 ptid_t resume_ptid;
955 const char *fn = nullptr;
956 symtab_and_line sal;
957 struct symbol *sym;
958
959 /* Pretend that we've ran. */
960 resume_ptid = user_visible_resume_ptid (1);
961 set_running (tp->inf->process_target (), resume_ptid, true);
962
963 step_into_inline_frame (tp);
964
965 frame = get_current_frame ();
966 sal = find_frame_sal (frame);
967 sym = get_frame_function (frame);
968
969 if (sym != nullptr)
970 fn = sym->print_name ();
971
972 if (sal.line == 0
973 || !function_name_is_marked_for_skip (fn, sal))
974 {
975 sm->count--;
976 return prepare_one_step (tp, sm);
977 }
978 }
979
980 pc = get_frame_pc (frame);
981 find_pc_line_pc_range (pc,
982 &tp->control.step_range_start,
983 &tp->control.step_range_end);
984
985 /* There's a problem in gcc (PR gcc/98780) that causes missing line
986 table entries, which results in a too large stepping range.
987 Use inlined_subroutine info to make the range more narrow. */
988 if (inline_skipped_frames (tp) > 0)
989 {
990 symbol *sym = inline_skipped_symbol (tp);
991 if (sym->aclass () == LOC_BLOCK)
992 {
993 const block *block = sym->value_block ();
994 if (block->end () < tp->control.step_range_end)
995 tp->control.step_range_end = block->end ();
996 }
997 }
998
999 tp->control.may_range_step = 1;
1000
1001 /* If we have no line info, switch to stepi mode. */
1002 if (tp->control.step_range_end == 0 && step_stop_if_no_debug)
1003 {
1004 tp->control.step_range_start = tp->control.step_range_end = 1;
1005 tp->control.may_range_step = 0;
1006 }
1007 else if (tp->control.step_range_end == 0)
1008 {
1009 const char *name;
1010
1011 if (find_pc_partial_function (pc, &name,
1012 &tp->control.step_range_start,
1013 &tp->control.step_range_end) == 0)
1014 error (_("Cannot find bounds of current function"));
1015
1016 target_terminal::ours_for_output ();
1017 gdb_printf (_("Single stepping until exit from function %s,"
1018 "\nwhich has no line number information.\n"),
1019 name);
1020 }
1021 }
1022 else
1023 {
1024 /* Say we are stepping, but stop after one insn whatever it does. */
1025 tp->control.step_range_start = tp->control.step_range_end = 1;
1026 if (!sm->skip_subroutines)
1027 /* It is stepi.
1028 Don't step over function calls, not even to functions lacking
1029 line numbers. */
1030 tp->control.step_over_calls = STEP_OVER_NONE;
1031 }
1032
1033 if (sm->skip_subroutines)
1034 tp->control.step_over_calls = STEP_OVER_ALL;
1035
1036 return 0;
1037 }
1038
1039 /* Done. */
1040 sm->set_finished ();
1041 return 1;
1042 }
1043
1044 \f
1045 /* Continue program at specified address. */
1046
1047 static void
1048 jump_command (const char *arg, int from_tty)
1049 {
1050 struct gdbarch *gdbarch = get_current_arch ();
1051 CORE_ADDR addr;
1052 struct symbol *fn;
1053 struct symbol *sfn;
1054 int async_exec;
1055
1056 ERROR_NO_INFERIOR;
1057 ensure_not_tfind_mode ();
1058 ensure_valid_thread ();
1059 ensure_not_running ();
1060
1061 /* Find out whether we must run in the background. */
1062 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (arg, &async_exec);
1063 arg = stripped.get ();
1064
1065 prepare_execution_command (current_inferior ()->top_target (), async_exec);
1066
1067 if (!arg)
1068 error_no_arg (_("starting address"));
1069
1070 std::vector<symtab_and_line> sals
1071 = decode_line_with_current_source (arg, DECODE_LINE_FUNFIRSTLINE);
1072 if (sals.size () != 1)
1073 {
1074 /* If multiple sal-objects were found, try dropping those that aren't
1075 from the current symtab. */
1076 struct symtab_and_line cursal = get_current_source_symtab_and_line ();
1077 sals.erase (std::remove_if (sals.begin (), sals.end (),
1078 [&] (const symtab_and_line &sal)
1079 {
1080 return sal.symtab != cursal.symtab;
1081 }), sals.end ());
1082 if (sals.size () != 1)
1083 error (_("Jump request is ambiguous: "
1084 "does not resolve to a single address"));
1085 }
1086
1087 symtab_and_line &sal = sals[0];
1088
1089 if (sal.symtab == 0 && sal.pc == 0)
1090 error (_("No source file has been specified."));
1091
1092 resolve_sal_pc (&sal); /* May error out. */
1093
1094 /* See if we are trying to jump to another function. */
1095 fn = get_frame_function (get_current_frame ());
1096 sfn = find_pc_sect_containing_function (sal.pc,
1097 find_pc_mapped_section (sal.pc));
1098 if (fn != nullptr && sfn != fn)
1099 {
1100 if (!query (_("Line %d is not in `%s'. Jump anyway? "), sal.line,
1101 fn->print_name ()))
1102 {
1103 error (_("Not confirmed."));
1104 /* NOTREACHED */
1105 }
1106 }
1107
1108 if (sfn != nullptr)
1109 {
1110 struct obj_section *section;
1111
1112 section = sfn->obj_section (sfn->objfile ());
1113 if (section_is_overlay (section)
1114 && !section_is_mapped (section))
1115 {
1116 if (!query (_("WARNING!!! Destination is in "
1117 "unmapped overlay! Jump anyway? ")))
1118 {
1119 error (_("Not confirmed."));
1120 /* NOTREACHED */
1121 }
1122 }
1123 }
1124
1125 addr = sal.pc;
1126
1127 if (from_tty)
1128 {
1129 gdb_printf (_("Continuing at "));
1130 gdb_puts (paddress (gdbarch, addr));
1131 gdb_printf (".\n");
1132 }
1133
1134 clear_proceed_status (0);
1135 proceed (addr, GDB_SIGNAL_0);
1136 }
1137 \f
1138 /* Continue program giving it specified signal. */
1139
1140 static void
1141 signal_command (const char *signum_exp, int from_tty)
1142 {
1143 enum gdb_signal oursig;
1144 int async_exec;
1145
1146 dont_repeat (); /* Too dangerous. */
1147 ERROR_NO_INFERIOR;
1148 ensure_not_tfind_mode ();
1149 ensure_valid_thread ();
1150 ensure_not_running ();
1151
1152 /* Find out whether we must run in the background. */
1153 gdb::unique_xmalloc_ptr<char> stripped
1154 = strip_bg_char (signum_exp, &async_exec);
1155 signum_exp = stripped.get ();
1156
1157 prepare_execution_command (current_inferior ()->top_target (), async_exec);
1158
1159 if (!signum_exp)
1160 error_no_arg (_("signal number"));
1161
1162 /* It would be even slicker to make signal names be valid expressions,
1163 (the type could be "enum $signal" or some such), then the user could
1164 assign them to convenience variables. */
1165 oursig = gdb_signal_from_name (signum_exp);
1166
1167 if (oursig == GDB_SIGNAL_UNKNOWN)
1168 {
1169 /* No, try numeric. */
1170 int num = parse_and_eval_long (signum_exp);
1171
1172 if (num == 0)
1173 oursig = GDB_SIGNAL_0;
1174 else
1175 oursig = gdb_signal_from_command (num);
1176 }
1177
1178 /* Look for threads other than the current that this command ends up
1179 resuming too (due to schedlock off), and warn if they'll get a
1180 signal delivered. "signal 0" is used to suppress a previous
1181 signal, but if the current thread is no longer the one that got
1182 the signal, then the user is potentially suppressing the signal
1183 of the wrong thread. */
1184 if (!non_stop)
1185 {
1186 int must_confirm = 0;
1187
1188 /* This indicates what will be resumed. Either a single thread,
1189 a whole process, or all threads of all processes. */
1190 ptid_t resume_ptid = user_visible_resume_ptid (0);
1191 process_stratum_target *resume_target
1192 = user_visible_resume_target (resume_ptid);
1193
1194 thread_info *current = inferior_thread ();
1195
1196 for (thread_info *tp : all_non_exited_threads (resume_target, resume_ptid))
1197 {
1198 if (tp == current)
1199 continue;
1200
1201 if (tp->stop_signal () != GDB_SIGNAL_0
1202 && signal_pass_state (tp->stop_signal ()))
1203 {
1204 if (!must_confirm)
1205 gdb_printf (_("Note:\n"));
1206 gdb_printf (_(" Thread %s previously stopped with signal %s, %s.\n"),
1207 print_thread_id (tp),
1208 gdb_signal_to_name (tp->stop_signal ()),
1209 gdb_signal_to_string (tp->stop_signal ()));
1210 must_confirm = 1;
1211 }
1212 }
1213
1214 if (must_confirm
1215 && !query (_("Continuing thread %s (the current thread) with specified signal will\n"
1216 "still deliver the signals noted above to their respective threads.\n"
1217 "Continue anyway? "),
1218 print_thread_id (inferior_thread ())))
1219 error (_("Not confirmed."));
1220 }
1221
1222 if (from_tty)
1223 {
1224 if (oursig == GDB_SIGNAL_0)
1225 gdb_printf (_("Continuing with no signal.\n"));
1226 else
1227 gdb_printf (_("Continuing with signal %s.\n"),
1228 gdb_signal_to_name (oursig));
1229 }
1230
1231 clear_proceed_status (0);
1232 proceed ((CORE_ADDR) -1, oursig);
1233 }
1234
1235 /* Queue a signal to be delivered to the current thread. */
1236
1237 static void
1238 queue_signal_command (const char *signum_exp, int from_tty)
1239 {
1240 enum gdb_signal oursig;
1241 struct thread_info *tp;
1242
1243 ERROR_NO_INFERIOR;
1244 ensure_not_tfind_mode ();
1245 ensure_valid_thread ();
1246 ensure_not_running ();
1247
1248 if (signum_exp == nullptr)
1249 error_no_arg (_("signal number"));
1250
1251 /* It would be even slicker to make signal names be valid expressions,
1252 (the type could be "enum $signal" or some such), then the user could
1253 assign them to convenience variables. */
1254 oursig = gdb_signal_from_name (signum_exp);
1255
1256 if (oursig == GDB_SIGNAL_UNKNOWN)
1257 {
1258 /* No, try numeric. */
1259 int num = parse_and_eval_long (signum_exp);
1260
1261 if (num == 0)
1262 oursig = GDB_SIGNAL_0;
1263 else
1264 oursig = gdb_signal_from_command (num);
1265 }
1266
1267 if (oursig != GDB_SIGNAL_0
1268 && !signal_pass_state (oursig))
1269 error (_("Signal handling set to not pass this signal to the program."));
1270
1271 tp = inferior_thread ();
1272 tp->set_stop_signal (oursig);
1273 }
1274
1275 /* Data for the FSM that manages the until (with no argument)
1276 command. */
1277
1278 struct until_next_fsm : public thread_fsm
1279 {
1280 /* The thread that as current when the command was executed. */
1281 int thread;
1282
1283 until_next_fsm (struct interp *cmd_interp, int thread)
1284 : thread_fsm (cmd_interp),
1285 thread (thread)
1286 {
1287 }
1288
1289 bool should_stop (struct thread_info *thread) override;
1290 void clean_up (struct thread_info *thread) override;
1291 enum async_reply_reason do_async_reply_reason () override;
1292 };
1293
1294 /* Implementation of the 'should_stop' FSM method for the until (with
1295 no arg) command. */
1296
1297 bool
1298 until_next_fsm::should_stop (struct thread_info *tp)
1299 {
1300 if (tp->control.stop_step)
1301 set_finished ();
1302
1303 return true;
1304 }
1305
1306 /* Implementation of the 'clean_up' FSM method for the until (with no
1307 arg) command. */
1308
1309 void
1310 until_next_fsm::clean_up (struct thread_info *thread)
1311 {
1312 delete_longjmp_breakpoint (thread->global_num);
1313 }
1314
1315 /* Implementation of the 'async_reply_reason' FSM method for the until
1316 (with no arg) command. */
1317
1318 enum async_reply_reason
1319 until_next_fsm::do_async_reply_reason ()
1320 {
1321 return EXEC_ASYNC_END_STEPPING_RANGE;
1322 }
1323
1324 /* Proceed until we reach a different source line with pc greater than
1325 our current one or exit the function. We skip calls in both cases.
1326
1327 Note that eventually this command should probably be changed so
1328 that only source lines are printed out when we hit the breakpoint
1329 we set. This may involve changes to wait_for_inferior and the
1330 proceed status code. */
1331
1332 static void
1333 until_next_command (int from_tty)
1334 {
1335 frame_info_ptr frame;
1336 CORE_ADDR pc;
1337 struct symbol *func;
1338 struct symtab_and_line sal;
1339 struct thread_info *tp = inferior_thread ();
1340 int thread = tp->global_num;
1341 struct until_next_fsm *sm;
1342
1343 clear_proceed_status (0);
1344 set_step_frame (tp);
1345
1346 frame = get_current_frame ();
1347
1348 /* Step until either exited from this function or greater
1349 than the current line (if in symbolic section) or pc (if
1350 not). */
1351
1352 pc = get_frame_pc (frame);
1353 func = find_pc_function (pc);
1354
1355 if (!func)
1356 {
1357 struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (pc);
1358
1359 if (msymbol.minsym == nullptr)
1360 error (_("Execution is not within a known function."));
1361
1362 tp->control.step_range_start = msymbol.value_address ();
1363 /* The upper-bound of step_range is exclusive. In order to make PC
1364 within the range, set the step_range_end with PC + 1. */
1365 tp->control.step_range_end = pc + 1;
1366 }
1367 else
1368 {
1369 sal = find_pc_line (pc, 0);
1370
1371 tp->control.step_range_start = func->value_block ()->entry_pc ();
1372 tp->control.step_range_end = sal.end;
1373
1374 /* By setting the step_range_end based on the current pc, we are
1375 assuming that the last line table entry for any given source line
1376 will have is_stmt set to true. This is not necessarily the case,
1377 there may be additional entries for the same source line with
1378 is_stmt set false. Consider the following code:
1379
1380 for (int i = 0; i < 10; i++)
1381 loop_body ();
1382
1383 Clang-13, will generate multiple line table entries at the end of
1384 the loop all associated with the 'for' line. The first of these
1385 entries is marked is_stmt true, but the other entries are is_stmt
1386 false.
1387
1388 If we only use the values in SAL, then our stepping range may not
1389 extend to the end of the loop. The until command will reach the
1390 end of the range, find a non is_stmt instruction, and step to the
1391 next is_stmt instruction. This stopping point, however, will be
1392 inside the loop, which is not what we wanted.
1393
1394 Instead, we now check any subsequent line table entries to see if
1395 they are for the same line. If they are, and they are marked
1396 is_stmt false, then we extend the end of our stepping range.
1397
1398 When we finish this process the end of the stepping range will
1399 point either to a line with a different line number, or, will
1400 point at an address for the same line number that is marked as a
1401 statement. */
1402
1403 struct symtab_and_line final_sal
1404 = find_pc_line (tp->control.step_range_end, 0);
1405
1406 while (final_sal.line == sal.line && final_sal.symtab == sal.symtab
1407 && !final_sal.is_stmt)
1408 {
1409 tp->control.step_range_end = final_sal.end;
1410 final_sal = find_pc_line (final_sal.end, 0);
1411 }
1412 }
1413 tp->control.may_range_step = 1;
1414
1415 tp->control.step_over_calls = STEP_OVER_ALL;
1416
1417 set_longjmp_breakpoint (tp, get_frame_id (frame));
1418 delete_longjmp_breakpoint_cleanup lj_deleter (thread);
1419
1420 sm = new until_next_fsm (command_interp (), tp->global_num);
1421 tp->set_thread_fsm (std::unique_ptr<thread_fsm> (sm));
1422 lj_deleter.release ();
1423
1424 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
1425 }
1426
1427 static void
1428 until_command (const char *arg, int from_tty)
1429 {
1430 int async_exec;
1431
1432 ERROR_NO_INFERIOR;
1433 ensure_not_tfind_mode ();
1434 ensure_valid_thread ();
1435 ensure_not_running ();
1436
1437 /* Find out whether we must run in the background. */
1438 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (arg, &async_exec);
1439 arg = stripped.get ();
1440
1441 prepare_execution_command (current_inferior ()->top_target (), async_exec);
1442
1443 if (arg)
1444 until_break_command (arg, from_tty, 0);
1445 else
1446 until_next_command (from_tty);
1447 }
1448
1449 static void
1450 advance_command (const char *arg, int from_tty)
1451 {
1452 int async_exec;
1453
1454 ERROR_NO_INFERIOR;
1455 ensure_not_tfind_mode ();
1456 ensure_valid_thread ();
1457 ensure_not_running ();
1458
1459 if (arg == nullptr)
1460 error_no_arg (_("a location"));
1461
1462 /* Find out whether we must run in the background. */
1463 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (arg, &async_exec);
1464 arg = stripped.get ();
1465
1466 prepare_execution_command (current_inferior ()->top_target (), async_exec);
1467
1468 until_break_command (arg, from_tty, 1);
1469 }
1470 \f
1471 /* See inferior.h. */
1472
1473 struct value *
1474 get_return_value (struct symbol *func_symbol, struct value *function)
1475 {
1476 regcache *stop_regs = get_current_regcache ();
1477 struct gdbarch *gdbarch = stop_regs->arch ();
1478 struct value *value;
1479
1480 struct type *value_type
1481 = check_typedef (func_symbol->type ()->target_type ());
1482 gdb_assert (value_type->code () != TYPE_CODE_VOID);
1483
1484 if (is_nocall_function (check_typedef (function->type ())))
1485 {
1486 warning (_("Function '%s' does not follow the target calling "
1487 "convention, cannot determine its returned value."),
1488 func_symbol->print_name ());
1489
1490 return nullptr;
1491 }
1492
1493 /* FIXME: 2003-09-27: When returning from a nested inferior function
1494 call, it's possible (with no help from the architecture vector)
1495 to locate and return/print a "struct return" value. This is just
1496 a more complicated case of what is already being done in the
1497 inferior function call code. In fact, when inferior function
1498 calls are made async, this will likely be made the norm. */
1499
1500 switch (gdbarch_return_value_as_value (gdbarch, function, value_type,
1501 nullptr, nullptr, nullptr))
1502 {
1503 case RETURN_VALUE_REGISTER_CONVENTION:
1504 case RETURN_VALUE_ABI_RETURNS_ADDRESS:
1505 case RETURN_VALUE_ABI_PRESERVES_ADDRESS:
1506 gdbarch_return_value_as_value (gdbarch, function, value_type, stop_regs,
1507 &value, nullptr);
1508 break;
1509 case RETURN_VALUE_STRUCT_CONVENTION:
1510 value = nullptr;
1511 break;
1512 default:
1513 internal_error (_("bad switch"));
1514 }
1515
1516 return value;
1517 }
1518
1519 /* The captured function return value/type and its position in the
1520 value history. */
1521
1522 struct return_value_info
1523 {
1524 /* The captured return value. May be NULL if we weren't able to
1525 retrieve it. See get_return_value. */
1526 struct value *value;
1527
1528 /* The return type. In some cases, we'll not be able extract the
1529 return value, but we always know the type. */
1530 struct type *type;
1531
1532 /* If we captured a value, this is the value history index. */
1533 int value_history_index;
1534 };
1535
1536 /* Helper for print_return_value. */
1537
1538 static void
1539 print_return_value_1 (struct ui_out *uiout, struct return_value_info *rv)
1540 {
1541 if (rv->value != nullptr)
1542 {
1543 /* Print it. */
1544 uiout->text ("Value returned is ");
1545 uiout->field_fmt ("gdb-result-var", "$%d",
1546 rv->value_history_index);
1547 uiout->text (" = ");
1548
1549 if (finish_print)
1550 {
1551 struct value_print_options opts;
1552 get_user_print_options (&opts);
1553
1554 string_file stb;
1555 value_print (rv->value, &stb, &opts);
1556 uiout->field_stream ("return-value", stb);
1557 }
1558 else
1559 uiout->field_string ("return-value", _("<not displayed>"),
1560 metadata_style.style ());
1561 uiout->text ("\n");
1562 }
1563 else
1564 {
1565 std::string type_name = type_to_string (rv->type);
1566 uiout->text ("Value returned has type: ");
1567 uiout->field_string ("return-type", type_name);
1568 uiout->text (".");
1569 uiout->text (" Cannot determine contents\n");
1570 }
1571 }
1572
1573 /* Print the result of a function at the end of a 'finish' command.
1574 RV points at an object representing the captured return value/type
1575 and its position in the value history. */
1576
1577 void
1578 print_return_value (struct ui_out *uiout, struct return_value_info *rv)
1579 {
1580 if (rv->type == nullptr
1581 || check_typedef (rv->type)->code () == TYPE_CODE_VOID)
1582 return;
1583
1584 try
1585 {
1586 /* print_return_value_1 can throw an exception in some
1587 circumstances. We need to catch this so that we still
1588 delete the breakpoint. */
1589 print_return_value_1 (uiout, rv);
1590 }
1591 catch (const gdb_exception_error &ex)
1592 {
1593 exception_print (gdb_stdout, ex);
1594 }
1595 }
1596
1597 /* Data for the FSM that manages the finish command. */
1598
1599 struct finish_command_fsm : public thread_fsm
1600 {
1601 /* The momentary breakpoint set at the function's return address in
1602 the caller. */
1603 breakpoint_up breakpoint;
1604
1605 /* The function that we're stepping out of. */
1606 struct symbol *function = nullptr;
1607
1608 /* If the FSM finishes successfully, this stores the function's
1609 return value. */
1610 struct return_value_info return_value_info {};
1611
1612 /* If the current function uses the "struct return convention",
1613 this holds the address at which the value being returned will
1614 be stored, or zero if that address could not be determined or
1615 the "struct return convention" is not being used. */
1616 CORE_ADDR return_buf;
1617
1618 explicit finish_command_fsm (struct interp *cmd_interp)
1619 : thread_fsm (cmd_interp)
1620 {
1621 }
1622
1623 bool should_stop (struct thread_info *thread) override;
1624 void clean_up (struct thread_info *thread) override;
1625 struct return_value_info *return_value () override;
1626 enum async_reply_reason do_async_reply_reason () override;
1627 };
1628
1629 /* Implementation of the 'should_stop' FSM method for the finish
1630 commands. Detects whether the thread stepped out of the function
1631 successfully, and if so, captures the function's return value and
1632 marks the FSM finished. */
1633
1634 bool
1635 finish_command_fsm::should_stop (struct thread_info *tp)
1636 {
1637 struct return_value_info *rv = &return_value_info;
1638
1639 if (function != nullptr
1640 && bpstat_find_breakpoint (tp->control.stop_bpstat,
1641 breakpoint.get ()) != nullptr)
1642 {
1643 /* We're done. */
1644 set_finished ();
1645
1646 rv->type = function->type ()->target_type ();
1647 if (rv->type == nullptr)
1648 internal_error (_("finish_command: function has no target type"));
1649
1650 if (check_typedef (rv->type)->code () != TYPE_CODE_VOID)
1651 {
1652 struct value *func;
1653
1654 func = read_var_value (function, nullptr, get_current_frame ());
1655
1656 if (return_buf != 0)
1657 /* Retrieve return value from the buffer where it was saved. */
1658 rv->value = value_at (rv->type, return_buf);
1659 else
1660 rv->value = get_return_value (function, func);
1661
1662 if (rv->value != nullptr)
1663 rv->value_history_index = rv->value->record_latest ();
1664 }
1665 }
1666 else if (tp->control.stop_step)
1667 {
1668 /* Finishing from an inline frame, or reverse finishing. In
1669 either case, there's no way to retrieve the return value. */
1670 set_finished ();
1671 }
1672
1673 return true;
1674 }
1675
1676 /* Implementation of the 'clean_up' FSM method for the finish
1677 commands. */
1678
1679 void
1680 finish_command_fsm::clean_up (struct thread_info *thread)
1681 {
1682 breakpoint.reset ();
1683 delete_longjmp_breakpoint (thread->global_num);
1684 }
1685
1686 /* Implementation of the 'return_value' FSM method for the finish
1687 commands. */
1688
1689 struct return_value_info *
1690 finish_command_fsm::return_value ()
1691 {
1692 return &return_value_info;
1693 }
1694
1695 /* Implementation of the 'async_reply_reason' FSM method for the
1696 finish commands. */
1697
1698 enum async_reply_reason
1699 finish_command_fsm::do_async_reply_reason ()
1700 {
1701 if (execution_direction == EXEC_REVERSE)
1702 return EXEC_ASYNC_END_STEPPING_RANGE;
1703 else
1704 return EXEC_ASYNC_FUNCTION_FINISHED;
1705 }
1706
1707 /* finish_backward -- helper function for finish_command. */
1708
1709 static void
1710 finish_backward (struct finish_command_fsm *sm)
1711 {
1712 struct symtab_and_line sal;
1713 struct thread_info *tp = inferior_thread ();
1714 CORE_ADDR pc;
1715 CORE_ADDR func_addr;
1716 CORE_ADDR alt_entry_point;
1717 CORE_ADDR entry_point;
1718 frame_info_ptr frame = get_selected_frame (nullptr);
1719 struct gdbarch *gdbarch = get_frame_arch (frame);
1720
1721 pc = get_frame_pc (get_current_frame ());
1722
1723 if (find_pc_partial_function (pc, nullptr, &func_addr, nullptr) == 0)
1724 error (_("Cannot find bounds of current function"));
1725
1726 sal = find_pc_line (func_addr, 0);
1727 alt_entry_point = sal.pc;
1728 entry_point = alt_entry_point;
1729
1730 if (gdbarch_skip_entrypoint_p (gdbarch))
1731 /* Some architectures, like PowerPC use local and global entry points.
1732 There is only one Entry Point (GEP = LEP) for other architectures.
1733 The GEP is an alternate entry point. The LEP is the normal entry point.
1734 The value of entry_point was initialized to the alternate entry point
1735 (GEP). It will be adjusted to the normal entry point if the function
1736 has two entry points. */
1737 entry_point = gdbarch_skip_entrypoint (gdbarch, sal.pc);
1738
1739 tp->control.proceed_to_finish = 1;
1740 /* Special case: if we're sitting at the function entry point,
1741 then all we need to do is take a reverse singlestep. We
1742 don't need to set a breakpoint, and indeed it would do us
1743 no good to do so.
1744
1745 Note that this can only happen at frame #0, since there's
1746 no way that a function up the stack can have a return address
1747 that's equal to its entry point. */
1748
1749 if ((pc < alt_entry_point) || (pc > entry_point))
1750 {
1751 /* We are in the body of the function. Set a breakpoint to go back to
1752 the normal entry point. */
1753 symtab_and_line sr_sal;
1754 sr_sal.pc = entry_point;
1755 sr_sal.pspace = get_frame_program_space (frame);
1756 insert_step_resume_breakpoint_at_sal (gdbarch,
1757 sr_sal, null_frame_id);
1758
1759 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
1760 }
1761 else
1762 {
1763 /* We are either at one of the entry points or between the entry points.
1764 If we are not at the alt_entry point, go back to the alt_entry_point
1765 If we at the normal entry point step back one instruction, when we
1766 stop we will determine if we entered via the entry point or the
1767 alternate entry point. If we are at the alternate entry point,
1768 single step back to the function call. */
1769 tp->control.step_range_start = tp->control.step_range_end = 1;
1770 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
1771 }
1772 }
1773
1774 /* finish_forward -- helper function for finish_command. FRAME is the
1775 frame that called the function we're about to step out of. */
1776
1777 static void
1778 finish_forward (struct finish_command_fsm *sm, frame_info_ptr frame)
1779 {
1780 struct frame_id frame_id = get_frame_id (frame);
1781 struct gdbarch *gdbarch = get_frame_arch (frame);
1782 struct symtab_and_line sal;
1783 struct thread_info *tp = inferior_thread ();
1784
1785 sal = find_pc_line (get_frame_pc (frame), 0);
1786 sal.pc = get_frame_pc (frame);
1787
1788 sm->breakpoint = set_momentary_breakpoint (gdbarch, sal,
1789 get_stack_frame_id (frame),
1790 bp_finish);
1791
1792 /* set_momentary_breakpoint invalidates FRAME. */
1793 frame = nullptr;
1794
1795 set_longjmp_breakpoint (tp, frame_id);
1796
1797 /* We want to print return value, please... */
1798 tp->control.proceed_to_finish = 1;
1799
1800 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
1801 }
1802
1803 /* Skip frames for "finish". */
1804
1805 static frame_info_ptr
1806 skip_finish_frames (frame_info_ptr frame)
1807 {
1808 frame_info_ptr start;
1809
1810 do
1811 {
1812 start = frame;
1813
1814 frame = skip_tailcall_frames (frame);
1815 if (frame == nullptr)
1816 break;
1817
1818 frame = skip_unwritable_frames (frame);
1819 if (frame == nullptr)
1820 break;
1821 }
1822 while (start != frame);
1823
1824 return frame;
1825 }
1826
1827 /* "finish": Set a temporary breakpoint at the place the selected
1828 frame will return to, then continue. */
1829
1830 static void
1831 finish_command (const char *arg, int from_tty)
1832 {
1833 frame_info_ptr frame;
1834 int async_exec;
1835 struct finish_command_fsm *sm;
1836 struct thread_info *tp;
1837
1838 ERROR_NO_INFERIOR;
1839 ensure_not_tfind_mode ();
1840 ensure_valid_thread ();
1841 ensure_not_running ();
1842
1843 /* Find out whether we must run in the background. */
1844 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (arg, &async_exec);
1845 arg = stripped.get ();
1846
1847 prepare_execution_command (current_inferior ()->top_target (), async_exec);
1848
1849 if (arg)
1850 error (_("The \"finish\" command does not take any arguments."));
1851
1852 frame = get_prev_frame (get_selected_frame (_("No selected frame.")));
1853 if (frame == 0)
1854 error (_("\"finish\" not meaningful in the outermost frame."));
1855
1856 clear_proceed_status (0);
1857
1858 tp = inferior_thread ();
1859
1860 sm = new finish_command_fsm (command_interp ());
1861
1862 tp->set_thread_fsm (std::unique_ptr<thread_fsm> (sm));
1863
1864 /* Finishing from an inline frame is completely different. We don't
1865 try to show the "return value" - no way to locate it. */
1866 if (get_frame_type (get_selected_frame (_("No selected frame.")))
1867 == INLINE_FRAME)
1868 {
1869 /* Claim we are stepping in the calling frame. An empty step
1870 range means that we will stop once we aren't in a function
1871 called by that frame. We don't use the magic "1" value for
1872 step_range_end, because then infrun will think this is nexti,
1873 and not step over the rest of this inlined function call. */
1874 set_step_info (tp, frame, {});
1875 tp->control.step_range_start = get_frame_pc (frame);
1876 tp->control.step_range_end = tp->control.step_range_start;
1877 tp->control.step_over_calls = STEP_OVER_ALL;
1878
1879 /* Print info on the selected frame, including level number but not
1880 source. */
1881 if (from_tty)
1882 {
1883 gdb_printf (_("Run till exit from "));
1884 print_stack_frame (get_selected_frame (nullptr), 1, LOCATION, 0);
1885 }
1886
1887 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
1888 return;
1889 }
1890
1891 /* Find the function we will return from. */
1892 frame_info_ptr callee_frame = get_selected_frame (nullptr);
1893 sm->function = find_pc_function (get_frame_pc (callee_frame));
1894 sm->return_buf = 0; /* Initialize buffer address is not available. */
1895
1896 /* Determine the return convention. If it is RETURN_VALUE_STRUCT_CONVENTION,
1897 attempt to determine the address of the return buffer. */
1898 if (sm->function != nullptr)
1899 {
1900 enum return_value_convention return_value;
1901 struct gdbarch *gdbarch = get_frame_arch (callee_frame);
1902
1903 struct type * val_type
1904 = check_typedef (sm->function->type ()->target_type ());
1905
1906 return_value
1907 = gdbarch_return_value_as_value (gdbarch,
1908 read_var_value (sm->function, nullptr,
1909 callee_frame),
1910 val_type, nullptr, nullptr, nullptr);
1911
1912 if (return_value == RETURN_VALUE_STRUCT_CONVENTION
1913 && val_type->code () != TYPE_CODE_VOID)
1914 sm->return_buf = gdbarch_get_return_buf_addr (gdbarch, val_type,
1915 callee_frame);
1916 }
1917
1918 /* Print info on the selected frame, including level number but not
1919 source. */
1920 if (from_tty)
1921 {
1922 if (execution_direction == EXEC_REVERSE)
1923 gdb_printf (_("Run back to call of "));
1924 else
1925 {
1926 if (sm->function != nullptr && TYPE_NO_RETURN (sm->function->type ())
1927 && !query (_("warning: Function %s does not return normally.\n"
1928 "Try to finish anyway? "),
1929 sm->function->print_name ()))
1930 error (_("Not confirmed."));
1931 gdb_printf (_("Run till exit from "));
1932 }
1933
1934 print_stack_frame (callee_frame, 1, LOCATION, 0);
1935 }
1936
1937 if (execution_direction == EXEC_REVERSE)
1938 finish_backward (sm);
1939 else
1940 {
1941 frame = skip_finish_frames (frame);
1942
1943 if (frame == nullptr)
1944 error (_("Cannot find the caller frame."));
1945
1946 finish_forward (sm, frame);
1947 }
1948 }
1949 \f
1950
1951 static void
1952 info_program_command (const char *args, int from_tty)
1953 {
1954 scoped_restore_current_thread restore_thread;
1955
1956 thread_info *tp;
1957
1958 /* In non-stop, since every thread is controlled individually, we'll
1959 show execution info about the current thread. In all-stop, we'll
1960 show execution info about the last stop. */
1961
1962 if (non_stop)
1963 {
1964 if (!target_has_execution ())
1965 {
1966 gdb_printf (_("The program being debugged is not being run.\n"));
1967 return;
1968 }
1969
1970 if (inferior_ptid == null_ptid)
1971 error (_("No selected thread."));
1972
1973 tp = inferior_thread ();
1974
1975 gdb_printf (_("Selected thread %s (%s).\n"),
1976 print_thread_id (tp),
1977 target_pid_to_str (tp->ptid).c_str ());
1978
1979 if (tp->state == THREAD_EXITED)
1980 {
1981 gdb_printf (_("Selected thread has exited.\n"));
1982 return;
1983 }
1984 else if (tp->state == THREAD_RUNNING)
1985 {
1986 gdb_printf (_("Selected thread is running.\n"));
1987 return;
1988 }
1989 }
1990 else
1991 {
1992 tp = get_previous_thread ();
1993
1994 if (tp == nullptr)
1995 {
1996 gdb_printf (_("The program being debugged is not being run.\n"));
1997 return;
1998 }
1999
2000 switch_to_thread (tp);
2001
2002 gdb_printf (_("Last stopped for thread %s (%s).\n"),
2003 print_thread_id (tp),
2004 target_pid_to_str (tp->ptid).c_str ());
2005
2006 if (tp->state == THREAD_EXITED)
2007 {
2008 gdb_printf (_("Thread has since exited.\n"));
2009 return;
2010 }
2011
2012 if (tp->state == THREAD_RUNNING)
2013 {
2014 gdb_printf (_("Thread is now running.\n"));
2015 return;
2016 }
2017 }
2018
2019 int num;
2020 bpstat *bs = tp->control.stop_bpstat;
2021 int stat = bpstat_num (&bs, &num);
2022
2023 target_files_info ();
2024 gdb_printf (_("Program stopped at %s.\n"),
2025 paddress (target_gdbarch (), tp->stop_pc ()));
2026 if (tp->control.stop_step)
2027 gdb_printf (_("It stopped after being stepped.\n"));
2028 else if (stat != 0)
2029 {
2030 /* There may be several breakpoints in the same place, so this
2031 isn't as strange as it seems. */
2032 while (stat != 0)
2033 {
2034 if (stat < 0)
2035 {
2036 gdb_printf (_("It stopped at a breakpoint "
2037 "that has since been deleted.\n"));
2038 }
2039 else
2040 gdb_printf (_("It stopped at breakpoint %d.\n"), num);
2041 stat = bpstat_num (&bs, &num);
2042 }
2043 }
2044 else if (tp->stop_signal () != GDB_SIGNAL_0)
2045 {
2046 gdb_printf (_("It stopped with signal %s, %s.\n"),
2047 gdb_signal_to_name (tp->stop_signal ()),
2048 gdb_signal_to_string (tp->stop_signal ()));
2049 }
2050
2051 if (from_tty)
2052 {
2053 gdb_printf (_("Type \"info stack\" or \"info "
2054 "registers\" for more information.\n"));
2055 }
2056 }
2057 \f
2058 static void
2059 environment_info (const char *var, int from_tty)
2060 {
2061 if (var)
2062 {
2063 const char *val = current_inferior ()->environment.get (var);
2064
2065 if (val)
2066 {
2067 gdb_puts (var);
2068 gdb_puts (" = ");
2069 gdb_puts (val);
2070 gdb_puts ("\n");
2071 }
2072 else
2073 {
2074 gdb_puts ("Environment variable \"");
2075 gdb_puts (var);
2076 gdb_puts ("\" not defined.\n");
2077 }
2078 }
2079 else
2080 {
2081 char **envp = current_inferior ()->environment.envp ();
2082
2083 for (int idx = 0; envp[idx] != nullptr; ++idx)
2084 {
2085 gdb_puts (envp[idx]);
2086 gdb_puts ("\n");
2087 }
2088 }
2089 }
2090
2091 static void
2092 set_environment_command (const char *arg, int from_tty)
2093 {
2094 const char *p, *val;
2095 int nullset = 0;
2096
2097 if (arg == 0)
2098 error_no_arg (_("environment variable and value"));
2099
2100 /* Find separation between variable name and value. */
2101 p = (char *) strchr (arg, '=');
2102 val = (char *) strchr (arg, ' ');
2103
2104 if (p != 0 && val != 0)
2105 {
2106 /* We have both a space and an equals. If the space is before the
2107 equals, walk forward over the spaces til we see a nonspace
2108 (possibly the equals). */
2109 if (p > val)
2110 while (*val == ' ')
2111 val++;
2112
2113 /* Now if the = is after the char following the spaces,
2114 take the char following the spaces. */
2115 if (p > val)
2116 p = val - 1;
2117 }
2118 else if (val != 0 && p == 0)
2119 p = val;
2120
2121 if (p == arg)
2122 error_no_arg (_("environment variable to set"));
2123
2124 if (p == 0 || p[1] == 0)
2125 {
2126 nullset = 1;
2127 if (p == 0)
2128 p = arg + strlen (arg); /* So that savestring below will work. */
2129 }
2130 else
2131 {
2132 /* Not setting variable value to null. */
2133 val = p + 1;
2134 while (*val == ' ' || *val == '\t')
2135 val++;
2136 }
2137
2138 while (p != arg && (p[-1] == ' ' || p[-1] == '\t'))
2139 p--;
2140
2141 std::string var (arg, p - arg);
2142 if (nullset)
2143 {
2144 gdb_printf (_("Setting environment variable "
2145 "\"%s\" to null value.\n"),
2146 var.c_str ());
2147 current_inferior ()->environment.set (var.c_str (), "");
2148 }
2149 else
2150 current_inferior ()->environment.set (var.c_str (), val);
2151 }
2152
2153 static void
2154 unset_environment_command (const char *var, int from_tty)
2155 {
2156 if (var == 0)
2157 {
2158 /* If there is no argument, delete all environment variables.
2159 Ask for confirmation if reading from the terminal. */
2160 if (!from_tty || query (_("Delete all environment variables? ")))
2161 current_inferior ()->environment.clear ();
2162 }
2163 else
2164 current_inferior ()->environment.unset (var);
2165 }
2166
2167 /* Handle the execution path (PATH variable). */
2168
2169 static const char path_var_name[] = "PATH";
2170
2171 static void
2172 path_info (const char *args, int from_tty)
2173 {
2174 gdb_puts ("Executable and object file path: ");
2175 gdb_puts (current_inferior ()->environment.get (path_var_name));
2176 gdb_puts ("\n");
2177 }
2178
2179 /* Add zero or more directories to the front of the execution path. */
2180
2181 static void
2182 path_command (const char *dirname, int from_tty)
2183 {
2184 const char *env;
2185
2186 dont_repeat ();
2187 env = current_inferior ()->environment.get (path_var_name);
2188 /* Can be null if path is not set. */
2189 if (!env)
2190 env = "";
2191 std::string exec_path = env;
2192 mod_path (dirname, exec_path);
2193 current_inferior ()->environment.set (path_var_name, exec_path.c_str ());
2194 if (from_tty)
2195 path_info (nullptr, from_tty);
2196 }
2197 \f
2198
2199 static void
2200 pad_to_column (string_file &stream, int col)
2201 {
2202 /* At least one space must be printed to separate columns. */
2203 stream.putc (' ');
2204 const int size = stream.size ();
2205 if (size < col)
2206 stream.puts (n_spaces (col - size));
2207 }
2208
2209 /* Print out the register NAME with value VAL, to FILE, in the default
2210 fashion. */
2211
2212 static void
2213 default_print_one_register_info (struct ui_file *file,
2214 const char *name,
2215 struct value *val)
2216 {
2217 struct type *regtype = val->type ();
2218 int print_raw_format;
2219 string_file format_stream;
2220 enum tab_stops
2221 {
2222 value_column_1 = 15,
2223 /* Give enough room for "0x", 16 hex digits and two spaces in
2224 preceding column. */
2225 value_column_2 = value_column_1 + 2 + 16 + 2,
2226 };
2227
2228 format_stream.puts (name);
2229 pad_to_column (format_stream, value_column_1);
2230
2231 print_raw_format = (val->entirely_available ()
2232 && !val->optimized_out ());
2233
2234 /* If virtual format is floating, print it that way, and in raw
2235 hex. */
2236 if (regtype->code () == TYPE_CODE_FLT
2237 || regtype->code () == TYPE_CODE_DECFLOAT)
2238 {
2239 struct value_print_options opts;
2240 const gdb_byte *valaddr = val->contents_for_printing ().data ();
2241 enum bfd_endian byte_order = type_byte_order (regtype);
2242
2243 get_user_print_options (&opts);
2244 opts.deref_ref = true;
2245
2246 common_val_print (val, &format_stream, 0, &opts, current_language);
2247
2248 if (print_raw_format)
2249 {
2250 pad_to_column (format_stream, value_column_2);
2251 format_stream.puts ("(raw ");
2252 print_hex_chars (&format_stream, valaddr, regtype->length (),
2253 byte_order, true);
2254 format_stream.putc (')');
2255 }
2256 }
2257 else
2258 {
2259 struct value_print_options opts;
2260
2261 /* Print the register in hex. */
2262 get_formatted_print_options (&opts, 'x');
2263 opts.deref_ref = true;
2264 common_val_print (val, &format_stream, 0, &opts, current_language);
2265 /* If not a vector register, print it also according to its
2266 natural format. */
2267 if (print_raw_format && regtype->is_vector () == 0)
2268 {
2269 pad_to_column (format_stream, value_column_2);
2270 get_user_print_options (&opts);
2271 opts.deref_ref = true;
2272 common_val_print (val, &format_stream, 0, &opts, current_language);
2273 }
2274 }
2275
2276 gdb_puts (format_stream.c_str (), file);
2277 gdb_printf (file, "\n");
2278 }
2279
2280 /* Print out the machine register regnum. If regnum is -1, print all
2281 registers (print_all == 1) or all non-float and non-vector
2282 registers (print_all == 0).
2283
2284 For most machines, having all_registers_info() print the
2285 register(s) one per line is good enough. If a different format is
2286 required, (eg, for MIPS or Pyramid 90x, which both have lots of
2287 regs), or there is an existing convention for showing all the
2288 registers, define the architecture method PRINT_REGISTERS_INFO to
2289 provide that format. */
2290
2291 void
2292 default_print_registers_info (struct gdbarch *gdbarch,
2293 struct ui_file *file,
2294 frame_info_ptr frame,
2295 int regnum, int print_all)
2296 {
2297 int i;
2298 const int numregs = gdbarch_num_cooked_regs (gdbarch);
2299
2300 for (i = 0; i < numregs; i++)
2301 {
2302 /* Decide between printing all regs, non-float / vector regs, or
2303 specific reg. */
2304 if (regnum == -1)
2305 {
2306 if (print_all)
2307 {
2308 if (!gdbarch_register_reggroup_p (gdbarch, i, all_reggroup))
2309 continue;
2310 }
2311 else
2312 {
2313 if (!gdbarch_register_reggroup_p (gdbarch, i, general_reggroup))
2314 continue;
2315 }
2316 }
2317 else
2318 {
2319 if (i != regnum)
2320 continue;
2321 }
2322
2323 /* If the register name is empty, it is undefined for this
2324 processor, so don't display anything. */
2325 if (*(gdbarch_register_name (gdbarch, i)) == '\0')
2326 continue;
2327
2328 default_print_one_register_info (file,
2329 gdbarch_register_name (gdbarch, i),
2330 value_of_register (i, frame));
2331 }
2332 }
2333
2334 void
2335 registers_info (const char *addr_exp, int fpregs)
2336 {
2337 frame_info_ptr frame;
2338 struct gdbarch *gdbarch;
2339
2340 if (!target_has_registers ())
2341 error (_("The program has no registers now."));
2342 frame = get_selected_frame (nullptr);
2343 gdbarch = get_frame_arch (frame);
2344
2345 if (!addr_exp)
2346 {
2347 gdbarch_print_registers_info (gdbarch, gdb_stdout,
2348 frame, -1, fpregs);
2349 return;
2350 }
2351
2352 while (*addr_exp != '\0')
2353 {
2354 const char *start;
2355 const char *end;
2356
2357 /* Skip leading white space. */
2358 addr_exp = skip_spaces (addr_exp);
2359
2360 /* Discard any leading ``$''. Check that there is something
2361 resembling a register following it. */
2362 if (addr_exp[0] == '$')
2363 addr_exp++;
2364 if (isspace ((*addr_exp)) || (*addr_exp) == '\0')
2365 error (_("Missing register name"));
2366
2367 /* Find the start/end of this register name/num/group. */
2368 start = addr_exp;
2369 while ((*addr_exp) != '\0' && !isspace ((*addr_exp)))
2370 addr_exp++;
2371 end = addr_exp;
2372
2373 /* Figure out what we've found and display it. */
2374
2375 /* A register name? */
2376 {
2377 int regnum = user_reg_map_name_to_regnum (gdbarch, start, end - start);
2378
2379 if (regnum >= 0)
2380 {
2381 /* User registers lie completely outside of the range of
2382 normal registers. Catch them early so that the target
2383 never sees them. */
2384 if (regnum >= gdbarch_num_cooked_regs (gdbarch))
2385 {
2386 struct value *regval = value_of_user_reg (regnum, frame);
2387 const char *regname = user_reg_map_regnum_to_name (gdbarch,
2388 regnum);
2389
2390 /* Print in the same fashion
2391 gdbarch_print_registers_info's default
2392 implementation prints. */
2393 default_print_one_register_info (gdb_stdout,
2394 regname,
2395 regval);
2396 }
2397 else
2398 gdbarch_print_registers_info (gdbarch, gdb_stdout,
2399 frame, regnum, fpregs);
2400 continue;
2401 }
2402 }
2403
2404 /* A register group? */
2405 {
2406 const struct reggroup *group = nullptr;
2407 for (const struct reggroup *g : gdbarch_reggroups (gdbarch))
2408 {
2409 /* Don't bother with a length check. Should the user
2410 enter a short register group name, go with the first
2411 group that matches. */
2412 if (strncmp (start, g->name (), end - start) == 0)
2413 {
2414 group = g;
2415 break;
2416 }
2417 }
2418 if (group != nullptr)
2419 {
2420 int regnum;
2421
2422 for (regnum = 0;
2423 regnum < gdbarch_num_cooked_regs (gdbarch);
2424 regnum++)
2425 {
2426 if (gdbarch_register_reggroup_p (gdbarch, regnum, group))
2427 gdbarch_print_registers_info (gdbarch,
2428 gdb_stdout, frame,
2429 regnum, fpregs);
2430 }
2431 continue;
2432 }
2433 }
2434
2435 /* Nothing matched. */
2436 error (_("Invalid register `%.*s'"), (int) (end - start), start);
2437 }
2438 }
2439
2440 static void
2441 info_all_registers_command (const char *addr_exp, int from_tty)
2442 {
2443 registers_info (addr_exp, 1);
2444 }
2445
2446 static void
2447 info_registers_command (const char *addr_exp, int from_tty)
2448 {
2449 registers_info (addr_exp, 0);
2450 }
2451
2452 static void
2453 print_vector_info (struct ui_file *file,
2454 frame_info_ptr frame, const char *args)
2455 {
2456 struct gdbarch *gdbarch = get_frame_arch (frame);
2457
2458 if (gdbarch_print_vector_info_p (gdbarch))
2459 gdbarch_print_vector_info (gdbarch, file, frame, args);
2460 else
2461 {
2462 int regnum;
2463 int printed_something = 0;
2464
2465 for (regnum = 0; regnum < gdbarch_num_cooked_regs (gdbarch); regnum++)
2466 {
2467 if (gdbarch_register_reggroup_p (gdbarch, regnum, vector_reggroup))
2468 {
2469 printed_something = 1;
2470 gdbarch_print_registers_info (gdbarch, file, frame, regnum, 1);
2471 }
2472 }
2473 if (!printed_something)
2474 gdb_printf (file, "No vector information\n");
2475 }
2476 }
2477
2478 static void
2479 info_vector_command (const char *args, int from_tty)
2480 {
2481 if (!target_has_registers ())
2482 error (_("The program has no registers now."));
2483
2484 print_vector_info (gdb_stdout, get_selected_frame (nullptr), args);
2485 }
2486 \f
2487 /* Kill the inferior process. Make us have no inferior. */
2488
2489 static void
2490 kill_command (const char *arg, int from_tty)
2491 {
2492 /* FIXME: This should not really be inferior_ptid (or target_has_execution).
2493 It should be a distinct flag that indicates that a target is active, cuz
2494 some targets don't have processes! */
2495
2496 if (inferior_ptid == null_ptid)
2497 error (_("The program is not being run."));
2498 if (!query (_("Kill the program being debugged? ")))
2499 error (_("Not confirmed."));
2500
2501 int pid = current_inferior ()->pid;
2502 /* Save the pid as a string before killing the inferior, since that
2503 may unpush the current target, and we need the string after. */
2504 std::string pid_str = target_pid_to_str (ptid_t (pid));
2505 int infnum = current_inferior ()->num;
2506
2507 target_kill ();
2508 bfd_cache_close_all ();
2509
2510 update_previous_thread ();
2511
2512 if (print_inferior_events)
2513 gdb_printf (_("[Inferior %d (%s) killed]\n"),
2514 infnum, pid_str.c_str ());
2515 }
2516
2517 /* Used in `attach&' command. Proceed threads of inferior INF iff
2518 they stopped due to debugger request, and when they did, they
2519 reported a clean stop (GDB_SIGNAL_0). Do not proceed threads that
2520 have been explicitly been told to stop. */
2521
2522 static void
2523 proceed_after_attach (inferior *inf)
2524 {
2525 /* Don't error out if the current thread is running, because
2526 there may be other stopped threads. */
2527
2528 /* Backup current thread and selected frame. */
2529 scoped_restore_current_thread restore_thread;
2530
2531 for (thread_info *thread : inf->non_exited_threads ())
2532 if (!thread->executing ()
2533 && !thread->stop_requested
2534 && thread->stop_signal () == GDB_SIGNAL_0)
2535 {
2536 switch_to_thread (thread);
2537 clear_proceed_status (0);
2538 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
2539 }
2540 }
2541
2542 /* See inferior.h. */
2543
2544 void
2545 setup_inferior (int from_tty)
2546 {
2547 struct inferior *inferior;
2548
2549 inferior = current_inferior ();
2550 inferior->needs_setup = false;
2551
2552 /* If no exec file is yet known, try to determine it from the
2553 process itself. */
2554 if (get_exec_file (0) == nullptr)
2555 exec_file_locate_attach (inferior_ptid.pid (), 1, from_tty);
2556 else
2557 {
2558 reopen_exec_file ();
2559 reread_symbols (from_tty);
2560 }
2561
2562 /* Take any necessary post-attaching actions for this platform. */
2563 target_post_attach (inferior_ptid.pid ());
2564
2565 post_create_inferior (from_tty);
2566 }
2567
2568 /* What to do after the first program stops after attaching. */
2569 enum attach_post_wait_mode
2570 {
2571 /* Do nothing. Leaves threads as they are. */
2572 ATTACH_POST_WAIT_NOTHING,
2573
2574 /* Re-resume threads that are marked running. */
2575 ATTACH_POST_WAIT_RESUME,
2576
2577 /* Stop all threads. */
2578 ATTACH_POST_WAIT_STOP,
2579 };
2580
2581 /* Called after we've attached to a process and we've seen it stop for
2582 the first time. Resume, stop, or don't touch the threads according
2583 to MODE. */
2584
2585 static void
2586 attach_post_wait (int from_tty, enum attach_post_wait_mode mode)
2587 {
2588 struct inferior *inferior;
2589
2590 inferior = current_inferior ();
2591 inferior->control.stop_soon = NO_STOP_QUIETLY;
2592
2593 if (inferior->needs_setup)
2594 setup_inferior (from_tty);
2595
2596 if (mode == ATTACH_POST_WAIT_RESUME)
2597 {
2598 /* The user requested an `attach&', so be sure to leave threads
2599 that didn't get a signal running. */
2600
2601 /* Immediately resume all suspended threads of this inferior,
2602 and this inferior only. This should have no effect on
2603 already running threads. If a thread has been stopped with a
2604 signal, leave it be. */
2605 if (non_stop)
2606 proceed_after_attach (inferior);
2607 else
2608 {
2609 if (inferior_thread ()->stop_signal () == GDB_SIGNAL_0)
2610 {
2611 clear_proceed_status (0);
2612 proceed ((CORE_ADDR) -1, GDB_SIGNAL_DEFAULT);
2613 }
2614 }
2615 }
2616 else if (mode == ATTACH_POST_WAIT_STOP)
2617 {
2618 /* The user requested a plain `attach', so be sure to leave
2619 the inferior stopped. */
2620
2621 /* At least the current thread is already stopped. */
2622
2623 /* In all-stop, by definition, all threads have to be already
2624 stopped at this point. In non-stop, however, although the
2625 selected thread is stopped, others may still be executing.
2626 Be sure to explicitly stop all threads of the process. This
2627 should have no effect on already stopped threads. */
2628 if (non_stop)
2629 target_stop (ptid_t (inferior->pid));
2630 else if (target_is_non_stop_p ())
2631 {
2632 struct thread_info *lowest = inferior_thread ();
2633
2634 stop_all_threads ("attaching");
2635
2636 /* It's not defined which thread will report the attach
2637 stop. For consistency, always select the thread with
2638 lowest GDB number, which should be the main thread, if it
2639 still exists. */
2640 for (thread_info *thread : current_inferior ()->non_exited_threads ())
2641 if (thread->inf->num < lowest->inf->num
2642 || thread->per_inf_num < lowest->per_inf_num)
2643 lowest = thread;
2644
2645 switch_to_thread (lowest);
2646 }
2647
2648 /* Tell the user/frontend where we're stopped. */
2649 normal_stop ();
2650 if (deprecated_attach_hook)
2651 deprecated_attach_hook ();
2652 }
2653 }
2654
2655 /* "attach" command entry point. Takes a program started up outside
2656 of gdb and ``attaches'' to it. This stops it cold in its tracks
2657 and allows us to start debugging it. */
2658
2659 void
2660 attach_command (const char *args, int from_tty)
2661 {
2662 int async_exec;
2663 struct target_ops *attach_target;
2664 struct inferior *inferior = current_inferior ();
2665 enum attach_post_wait_mode mode;
2666
2667 dont_repeat (); /* Not for the faint of heart */
2668
2669 scoped_disable_commit_resumed disable_commit_resumed ("attaching");
2670
2671 if (gdbarch_has_global_solist (target_gdbarch ()))
2672 /* Don't complain if all processes share the same symbol
2673 space. */
2674 ;
2675 else if (target_has_execution ())
2676 {
2677 if (query (_("A program is being debugged already. Kill it? ")))
2678 target_kill ();
2679 else
2680 error (_("Not killed."));
2681 }
2682
2683 /* Clean up any leftovers from other runs. Some other things from
2684 this function should probably be moved into target_pre_inferior. */
2685 target_pre_inferior (from_tty);
2686
2687 gdb::unique_xmalloc_ptr<char> stripped = strip_bg_char (args, &async_exec);
2688 args = stripped.get ();
2689
2690 attach_target = find_attach_target ();
2691
2692 prepare_execution_command (attach_target, async_exec);
2693
2694 if (non_stop && !attach_target->supports_non_stop ())
2695 error (_("Cannot attach to this target in non-stop mode"));
2696
2697 attach_target->attach (args, from_tty);
2698 /* to_attach should push the target, so after this point we
2699 shouldn't refer to attach_target again. */
2700 attach_target = nullptr;
2701
2702 infrun_debug_show_threads ("immediately after attach",
2703 current_inferior ()->non_exited_threads ());
2704
2705 /* Enable async mode if it is supported by the target. */
2706 if (target_can_async_p ())
2707 target_async (true);
2708
2709 /* Set up the "saved terminal modes" of the inferior
2710 based on what modes we are starting it with. */
2711 target_terminal::init ();
2712
2713 /* Install inferior's terminal modes. This may look like a no-op,
2714 as we've just saved them above, however, this does more than
2715 restore terminal settings:
2716
2717 - installs a SIGINT handler that forwards SIGINT to the inferior.
2718 Otherwise a Ctrl-C pressed just while waiting for the initial
2719 stop would end up as a spurious Quit.
2720
2721 - removes stdin from the event loop, which we need if attaching
2722 in the foreground, otherwise on targets that report an initial
2723 stop on attach (which are most) we'd process input/commands
2724 while we're in the event loop waiting for that stop. That is,
2725 before the attach continuation runs and the command is really
2726 finished. */
2727 target_terminal::inferior ();
2728
2729 /* Set up execution context to know that we should return from
2730 wait_for_inferior as soon as the target reports a stop. */
2731 init_wait_for_inferior ();
2732
2733 inferior->needs_setup = true;
2734
2735 if (target_is_non_stop_p ())
2736 {
2737 /* If we find that the current thread isn't stopped, explicitly
2738 do so now, because we're going to install breakpoints and
2739 poke at memory. */
2740
2741 if (async_exec)
2742 /* The user requested an `attach&'; stop just one thread. */
2743 target_stop (inferior_ptid);
2744 else
2745 /* The user requested an `attach', so stop all threads of this
2746 inferior. */
2747 target_stop (ptid_t (inferior_ptid.pid ()));
2748 }
2749
2750 /* Check for exec file mismatch, and let the user solve it. */
2751 validate_exec_file (from_tty);
2752
2753 mode = async_exec ? ATTACH_POST_WAIT_RESUME : ATTACH_POST_WAIT_STOP;
2754
2755 /* Some system don't generate traps when attaching to inferior.
2756 E.g. Mach 3 or GNU hurd. */
2757 if (!target_attach_no_wait ())
2758 {
2759 /* Careful here. See comments in inferior.h. Basically some
2760 OSes don't ignore SIGSTOPs on continue requests anymore. We
2761 need a way for handle_inferior_event to reset the stop_signal
2762 variable after an attach, and this is what
2763 STOP_QUIETLY_NO_SIGSTOP is for. */
2764 inferior->control.stop_soon = STOP_QUIETLY_NO_SIGSTOP;
2765
2766 /* Wait for stop. */
2767 inferior->add_continuation ([=] ()
2768 {
2769 attach_post_wait (from_tty, mode);
2770 });
2771
2772 /* Let infrun consider waiting for events out of this
2773 target. */
2774 inferior->process_target ()->threads_executing = true;
2775
2776 if (!target_is_async_p ())
2777 mark_infrun_async_event_handler ();
2778 return;
2779 }
2780 else
2781 attach_post_wait (from_tty, mode);
2782
2783 disable_commit_resumed.reset_and_commit ();
2784 }
2785
2786 /* We had just found out that the target was already attached to an
2787 inferior. PTID points at a thread of this new inferior, that is
2788 the most likely to be stopped right now, but not necessarily so.
2789 The new inferior is assumed to be already added to the inferior
2790 list at this point. If LEAVE_RUNNING, then leave the threads of
2791 this inferior running, except those we've explicitly seen reported
2792 as stopped. */
2793
2794 void
2795 notice_new_inferior (thread_info *thr, bool leave_running, int from_tty)
2796 {
2797 enum attach_post_wait_mode mode
2798 = leave_running ? ATTACH_POST_WAIT_RESUME : ATTACH_POST_WAIT_NOTHING;
2799
2800 gdb::optional<scoped_restore_current_thread> restore_thread;
2801
2802 if (inferior_ptid != null_ptid)
2803 restore_thread.emplace ();
2804
2805 /* Avoid reading registers -- we haven't fetched the target
2806 description yet. */
2807 switch_to_thread_no_regs (thr);
2808
2809 /* When we "notice" a new inferior we need to do all the things we
2810 would normally do if we had just attached to it. */
2811
2812 if (thr->executing ())
2813 {
2814 struct inferior *inferior = current_inferior ();
2815
2816 /* We're going to install breakpoints, and poke at memory,
2817 ensure that the inferior is stopped for a moment while we do
2818 that. */
2819 target_stop (inferior_ptid);
2820
2821 inferior->control.stop_soon = STOP_QUIETLY_REMOTE;
2822
2823 /* Wait for stop before proceeding. */
2824 inferior->add_continuation ([=] ()
2825 {
2826 attach_post_wait (from_tty, mode);
2827 });
2828
2829 return;
2830 }
2831
2832 attach_post_wait (from_tty, mode);
2833 }
2834
2835 /*
2836 * detach_command --
2837 * takes a program previously attached to and detaches it.
2838 * The program resumes execution and will no longer stop
2839 * on signals, etc. We better not have left any breakpoints
2840 * in the program or it'll die when it hits one. For this
2841 * to work, it may be necessary for the process to have been
2842 * previously attached. It *might* work if the program was
2843 * started via the normal ptrace (PTRACE_TRACEME).
2844 */
2845
2846 void
2847 detach_command (const char *args, int from_tty)
2848 {
2849 dont_repeat (); /* Not for the faint of heart. */
2850
2851 if (inferior_ptid == null_ptid)
2852 error (_("The program is not being run."));
2853
2854 scoped_disable_commit_resumed disable_commit_resumed ("detaching");
2855
2856 query_if_trace_running (from_tty);
2857
2858 disconnect_tracing ();
2859
2860 /* Hold a strong reference to the target while (maybe)
2861 detaching the parent. Otherwise detaching could close the
2862 target. */
2863 auto target_ref
2864 = target_ops_ref::new_reference (current_inferior ()->process_target ());
2865
2866 /* Save this before detaching, since detaching may unpush the
2867 process_stratum target. */
2868 bool was_non_stop_p = target_is_non_stop_p ();
2869
2870 target_detach (current_inferior (), from_tty);
2871
2872 update_previous_thread ();
2873
2874 /* The current inferior process was just detached successfully. Get
2875 rid of breakpoints that no longer make sense. Note we don't do
2876 this within target_detach because that is also used when
2877 following child forks, and in that case we will want to transfer
2878 breakpoints to the child, not delete them. */
2879 breakpoint_init_inferior (inf_exited);
2880
2881 /* If the solist is global across inferiors, don't clear it when we
2882 detach from a single inferior. */
2883 if (!gdbarch_has_global_solist (target_gdbarch ()))
2884 no_shared_libraries (nullptr, from_tty);
2885
2886 if (deprecated_detach_hook)
2887 deprecated_detach_hook ();
2888
2889 if (!was_non_stop_p)
2890 restart_after_all_stop_detach (as_process_stratum_target (target_ref.get ()));
2891
2892 disable_commit_resumed.reset_and_commit ();
2893 }
2894
2895 /* Disconnect from the current target without resuming it (leaving it
2896 waiting for a debugger).
2897
2898 We'd better not have left any breakpoints in the program or the
2899 next debugger will get confused. Currently only supported for some
2900 remote targets, since the normal attach mechanisms don't work on
2901 stopped processes on some native platforms (e.g. GNU/Linux). */
2902
2903 static void
2904 disconnect_command (const char *args, int from_tty)
2905 {
2906 dont_repeat (); /* Not for the faint of heart. */
2907 query_if_trace_running (from_tty);
2908 disconnect_tracing ();
2909 target_disconnect (args, from_tty);
2910 no_shared_libraries (nullptr, from_tty);
2911 init_thread_list ();
2912 update_previous_thread ();
2913 if (deprecated_detach_hook)
2914 deprecated_detach_hook ();
2915 }
2916
2917 /* Stop PTID in the current target, and tag the PTID threads as having
2918 been explicitly requested to stop. PTID can be a thread, a
2919 process, or minus_one_ptid, meaning all threads of all inferiors of
2920 the current target. */
2921
2922 static void
2923 stop_current_target_threads_ns (ptid_t ptid)
2924 {
2925 target_stop (ptid);
2926
2927 /* Tag the thread as having been explicitly requested to stop, so
2928 other parts of gdb know not to resume this thread automatically,
2929 if it was stopped due to an internal event. Limit this to
2930 non-stop mode, as when debugging a multi-threaded application in
2931 all-stop mode, we will only get one stop event --- it's undefined
2932 which thread will report the event. */
2933 set_stop_requested (current_inferior ()->process_target (),
2934 ptid, 1);
2935 }
2936
2937 /* See inferior.h. */
2938
2939 void
2940 interrupt_target_1 (bool all_threads)
2941 {
2942 scoped_disable_commit_resumed disable_commit_resumed ("interrupting");
2943
2944 if (non_stop)
2945 {
2946 if (all_threads)
2947 {
2948 scoped_restore_current_thread restore_thread;
2949
2950 for (inferior *inf : all_inferiors ())
2951 {
2952 switch_to_inferior_no_thread (inf);
2953 stop_current_target_threads_ns (minus_one_ptid);
2954 }
2955 }
2956 else
2957 stop_current_target_threads_ns (inferior_ptid);
2958 }
2959 else
2960 target_interrupt ();
2961
2962 disable_commit_resumed.reset_and_commit ();
2963 }
2964
2965 /* interrupt [-a]
2966 Stop the execution of the target while running in async mode, in
2967 the background. In all-stop, stop the whole process. In non-stop
2968 mode, stop the current thread only by default, or stop all threads
2969 if the `-a' switch is used. */
2970
2971 static void
2972 interrupt_command (const char *args, int from_tty)
2973 {
2974 if (target_can_async_p ())
2975 {
2976 int all_threads = 0;
2977
2978 dont_repeat (); /* Not for the faint of heart. */
2979
2980 if (args != nullptr
2981 && startswith (args, "-a"))
2982 all_threads = 1;
2983
2984 interrupt_target_1 (all_threads);
2985 }
2986 }
2987
2988 /* See inferior.h. */
2989
2990 void
2991 default_print_float_info (struct gdbarch *gdbarch, struct ui_file *file,
2992 frame_info_ptr frame, const char *args)
2993 {
2994 int regnum;
2995 int printed_something = 0;
2996
2997 for (regnum = 0; regnum < gdbarch_num_cooked_regs (gdbarch); regnum++)
2998 {
2999 if (gdbarch_register_reggroup_p (gdbarch, regnum, float_reggroup))
3000 {
3001 printed_something = 1;
3002 gdbarch_print_registers_info (gdbarch, file, frame, regnum, 1);
3003 }
3004 }
3005 if (!printed_something)
3006 gdb_printf (file, "No floating-point info "
3007 "available for this processor.\n");
3008 }
3009
3010 static void
3011 info_float_command (const char *args, int from_tty)
3012 {
3013 frame_info_ptr frame;
3014
3015 if (!target_has_registers ())
3016 error (_("The program has no registers now."));
3017
3018 frame = get_selected_frame (nullptr);
3019 gdbarch_print_float_info (get_frame_arch (frame), gdb_stdout, frame, args);
3020 }
3021 \f
3022 /* Implement `info proc' family of commands. */
3023
3024 static void
3025 info_proc_cmd_1 (const char *args, enum info_proc_what what, int from_tty)
3026 {
3027 struct gdbarch *gdbarch = get_current_arch ();
3028
3029 if (!target_info_proc (args, what))
3030 {
3031 if (gdbarch_info_proc_p (gdbarch))
3032 gdbarch_info_proc (gdbarch, args, what);
3033 else
3034 error (_("Not supported on this target."));
3035 }
3036 }
3037
3038 /* Implement `info proc' when given without any further parameters. */
3039
3040 static void
3041 info_proc_cmd (const char *args, int from_tty)
3042 {
3043 info_proc_cmd_1 (args, IP_MINIMAL, from_tty);
3044 }
3045
3046 /* Implement `info proc mappings'. */
3047
3048 static void
3049 info_proc_cmd_mappings (const char *args, int from_tty)
3050 {
3051 info_proc_cmd_1 (args, IP_MAPPINGS, from_tty);
3052 }
3053
3054 /* Implement `info proc stat'. */
3055
3056 static void
3057 info_proc_cmd_stat (const char *args, int from_tty)
3058 {
3059 info_proc_cmd_1 (args, IP_STAT, from_tty);
3060 }
3061
3062 /* Implement `info proc status'. */
3063
3064 static void
3065 info_proc_cmd_status (const char *args, int from_tty)
3066 {
3067 info_proc_cmd_1 (args, IP_STATUS, from_tty);
3068 }
3069
3070 /* Implement `info proc cwd'. */
3071
3072 static void
3073 info_proc_cmd_cwd (const char *args, int from_tty)
3074 {
3075 info_proc_cmd_1 (args, IP_CWD, from_tty);
3076 }
3077
3078 /* Implement `info proc cmdline'. */
3079
3080 static void
3081 info_proc_cmd_cmdline (const char *args, int from_tty)
3082 {
3083 info_proc_cmd_1 (args, IP_CMDLINE, from_tty);
3084 }
3085
3086 /* Implement `info proc exe'. */
3087
3088 static void
3089 info_proc_cmd_exe (const char *args, int from_tty)
3090 {
3091 info_proc_cmd_1 (args, IP_EXE, from_tty);
3092 }
3093
3094 /* Implement `info proc files'. */
3095
3096 static void
3097 info_proc_cmd_files (const char *args, int from_tty)
3098 {
3099 info_proc_cmd_1 (args, IP_FILES, from_tty);
3100 }
3101
3102 /* Implement `info proc all'. */
3103
3104 static void
3105 info_proc_cmd_all (const char *args, int from_tty)
3106 {
3107 info_proc_cmd_1 (args, IP_ALL, from_tty);
3108 }
3109
3110 /* Implement `show print finish'. */
3111
3112 static void
3113 show_print_finish (struct ui_file *file, int from_tty,
3114 struct cmd_list_element *c,
3115 const char *value)
3116 {
3117 gdb_printf (file, _("\
3118 Printing of return value after `finish' is %s.\n"),
3119 value);
3120 }
3121
3122
3123 /* This help string is used for the run, start, and starti commands.
3124 It is defined as a macro to prevent duplication. */
3125
3126 #define RUN_ARGS_HELP \
3127 "You may specify arguments to give it.\n\
3128 Args may include \"*\", or \"[...]\"; they are expanded using the\n\
3129 shell that will start the program (specified by the \"$SHELL\" environment\n\
3130 variable). Input and output redirection with \">\", \"<\", or \">>\"\n\
3131 are also allowed.\n\
3132 \n\
3133 With no arguments, uses arguments last specified (with \"run\" or \n\
3134 \"set args\"). To cancel previous arguments and run with no arguments,\n\
3135 use \"set args\" without arguments.\n\
3136 \n\
3137 To start the inferior without using a shell, use \"set startup-with-shell off\"."
3138
3139 void _initialize_infcmd ();
3140 void
3141 _initialize_infcmd ()
3142 {
3143 static struct cmd_list_element *info_proc_cmdlist;
3144 struct cmd_list_element *c = nullptr;
3145
3146 /* Add the filename of the terminal connected to inferior I/O. */
3147 auto tty_set_show
3148 = add_setshow_optional_filename_cmd ("inferior-tty", class_run, _("\
3149 Set terminal for future runs of program being debugged."), _(" \
3150 Show terminal for future runs of program being debugged."), _(" \
3151 Usage: set inferior-tty [TTY]\n\n \
3152 If TTY is omitted, the default behavior of using the same terminal as GDB\n \
3153 is restored."),
3154 set_tty_value,
3155 get_tty_value,
3156 show_inferior_tty_command,
3157 &setlist, &showlist);
3158 add_alias_cmd ("tty", tty_set_show.set, class_run, 0, &cmdlist);
3159
3160 auto args_set_show
3161 = add_setshow_string_noescape_cmd ("args", class_run, _("\
3162 Set argument list to give program being debugged when it is started."), _("\
3163 Show argument list to give program being debugged when it is started."), _("\
3164 Follow this command with any number of args, to be passed to the program."),
3165 set_args_value,
3166 get_args_value,
3167 show_args_command,
3168 &setlist, &showlist);
3169 set_cmd_completer (args_set_show.set, filename_completer);
3170
3171 auto cwd_set_show
3172 = add_setshow_string_noescape_cmd ("cwd", class_run, _("\
3173 Set the current working directory to be used when the inferior is started.\n \
3174 Changing this setting does not have any effect on inferiors that are\n \
3175 already running."),
3176 _("\
3177 Show the current working directory that is used when the inferior is started."),
3178 _("\
3179 Use this command to change the current working directory that will be used\n\
3180 when the inferior is started. This setting does not affect GDB's current\n\
3181 working directory."),
3182 set_cwd_value, get_inferior_cwd,
3183 show_cwd_command,
3184 &setlist, &showlist);
3185 set_cmd_completer (cwd_set_show.set, filename_completer);
3186
3187 c = add_cmd ("environment", no_class, environment_info, _("\
3188 The environment to give the program, or one variable's value.\n\
3189 With an argument VAR, prints the value of environment variable VAR to\n\
3190 give the program being debugged. With no arguments, prints the entire\n\
3191 environment to be given to the program."), &showlist);
3192 set_cmd_completer (c, noop_completer);
3193
3194 add_basic_prefix_cmd ("unset", no_class,
3195 _("Complement to certain \"set\" commands."),
3196 &unsetlist, 0, &cmdlist);
3197
3198 c = add_cmd ("environment", class_run, unset_environment_command, _("\
3199 Cancel environment variable VAR for the program.\n\
3200 This does not affect the program until the next \"run\" command."),
3201 &unsetlist);
3202 set_cmd_completer (c, noop_completer);
3203
3204 c = add_cmd ("environment", class_run, set_environment_command, _("\
3205 Set environment variable value to give the program.\n\
3206 Arguments are VAR VALUE where VAR is variable name and VALUE is value.\n\
3207 VALUES of environment variables are uninterpreted strings.\n\
3208 This does not affect the program until the next \"run\" command."),
3209 &setlist);
3210 set_cmd_completer (c, noop_completer);
3211
3212 c = add_com ("path", class_files, path_command, _("\
3213 Add directory DIR(s) to beginning of search path for object files.\n\
3214 $cwd in the path means the current working directory.\n\
3215 This path is equivalent to the $PATH shell variable. It is a list of\n\
3216 directories, separated by colons. These directories are searched to find\n\
3217 fully linked executable files and separately compiled object files as \
3218 needed."));
3219 set_cmd_completer (c, filename_completer);
3220
3221 c = add_cmd ("paths", no_class, path_info, _("\
3222 Current search path for finding object files.\n\
3223 $cwd in the path means the current working directory.\n\
3224 This path is equivalent to the $PATH shell variable. It is a list of\n\
3225 directories, separated by colons. These directories are searched to find\n\
3226 fully linked executable files and separately compiled object files as \
3227 needed."),
3228 &showlist);
3229 set_cmd_completer (c, noop_completer);
3230
3231 add_prefix_cmd ("kill", class_run, kill_command,
3232 _("Kill execution of program being debugged."),
3233 &killlist, 0, &cmdlist);
3234
3235 add_com ("attach", class_run, attach_command, _("\
3236 Attach to a process or file outside of GDB.\n\
3237 This command attaches to another target, of the same type as your last\n\
3238 \"target\" command (\"info files\" will show your target stack).\n\
3239 The command may take as argument a process id or a device file.\n\
3240 For a process id, you must have permission to send the process a signal,\n\
3241 and it must have the same effective uid as the debugger.\n\
3242 When using \"attach\" with a process id, the debugger finds the\n\
3243 program running in the process, looking first in the current working\n\
3244 directory, or (if not found there) using the source file search path\n\
3245 (see the \"directory\" command). You can also use the \"file\" command\n\
3246 to specify the program, and to load its symbol table."));
3247
3248 add_prefix_cmd ("detach", class_run, detach_command, _("\
3249 Detach a process or file previously attached.\n\
3250 If a process, it is no longer traced, and it continues its execution. If\n\
3251 you were debugging a file, the file is closed and gdb no longer accesses it."),
3252 &detachlist, 0, &cmdlist);
3253
3254 add_com ("disconnect", class_run, disconnect_command, _("\
3255 Disconnect from a target.\n\
3256 The target will wait for another debugger to connect. Not available for\n\
3257 all targets."));
3258
3259 c = add_com ("signal", class_run, signal_command, _("\
3260 Continue program with the specified signal.\n\
3261 Usage: signal SIGNAL\n\
3262 The SIGNAL argument is processed the same as the handle command.\n\
3263 \n\
3264 An argument of \"0\" means continue the program without sending it a signal.\n\
3265 This is useful in cases where the program stopped because of a signal,\n\
3266 and you want to resume the program while discarding the signal.\n\
3267 \n\
3268 In a multi-threaded program the signal is delivered to, or discarded from,\n\
3269 the current thread only."));
3270 set_cmd_completer (c, signal_completer);
3271
3272 c = add_com ("queue-signal", class_run, queue_signal_command, _("\
3273 Queue a signal to be delivered to the current thread when it is resumed.\n\
3274 Usage: queue-signal SIGNAL\n\
3275 The SIGNAL argument is processed the same as the handle command.\n\
3276 It is an error if the handling state of SIGNAL is \"nopass\".\n\
3277 \n\
3278 An argument of \"0\" means remove any currently queued signal from\n\
3279 the current thread. This is useful in cases where the program stopped\n\
3280 because of a signal, and you want to resume it while discarding the signal.\n\
3281 \n\
3282 In a multi-threaded program the signal is queued with, or discarded from,\n\
3283 the current thread only."));
3284 set_cmd_completer (c, signal_completer);
3285
3286 cmd_list_element *stepi_cmd
3287 = add_com ("stepi", class_run, stepi_command, _("\
3288 Step one instruction exactly.\n\
3289 Usage: stepi [N]\n\
3290 Argument N means step N times (or till program stops for another \
3291 reason)."));
3292 add_com_alias ("si", stepi_cmd, class_run, 0);
3293
3294 cmd_list_element *nexti_cmd
3295 = add_com ("nexti", class_run, nexti_command, _("\
3296 Step one instruction, but proceed through subroutine calls.\n\
3297 Usage: nexti [N]\n\
3298 Argument N means step N times (or till program stops for another \
3299 reason)."));
3300 add_com_alias ("ni", nexti_cmd, class_run, 0);
3301
3302 cmd_list_element *finish_cmd
3303 = add_com ("finish", class_run, finish_command, _("\
3304 Execute until selected stack frame returns.\n\
3305 Usage: finish\n\
3306 Upon return, the value returned is printed and put in the value history."));
3307 add_com_alias ("fin", finish_cmd, class_run, 1);
3308
3309 cmd_list_element *next_cmd
3310 = add_com ("next", class_run, next_command, _("\
3311 Step program, proceeding through subroutine calls.\n\
3312 Usage: next [N]\n\
3313 Unlike \"step\", if the current source line calls a subroutine,\n\
3314 this command does not enter the subroutine, but instead steps over\n\
3315 the call, in effect treating it as a single source line."));
3316 add_com_alias ("n", next_cmd, class_run, 1);
3317
3318 cmd_list_element *step_cmd
3319 = add_com ("step", class_run, step_command, _("\
3320 Step program until it reaches a different source line.\n\
3321 Usage: step [N]\n\
3322 Argument N means step N times (or till program stops for another \
3323 reason)."));
3324 add_com_alias ("s", step_cmd, class_run, 1);
3325
3326 cmd_list_element *until_cmd
3327 = add_com ("until", class_run, until_command, _("\
3328 Execute until past the current line or past a LOCATION.\n\
3329 Execute until the program reaches a source line greater than the current\n\
3330 or a specified location (same args as break command) within the current \
3331 frame."));
3332 set_cmd_completer (until_cmd, location_completer);
3333 add_com_alias ("u", until_cmd, class_run, 1);
3334
3335 c = add_com ("advance", class_run, advance_command, _("\
3336 Continue the program up to the given location (same form as args for break \
3337 command).\n\
3338 Execution will also stop upon exit from the current stack frame."));
3339 set_cmd_completer (c, location_completer);
3340
3341 cmd_list_element *jump_cmd
3342 = add_com ("jump", class_run, jump_command, _("\
3343 Continue program being debugged at specified line or address.\n\
3344 Usage: jump LOCATION\n\
3345 Give as argument either LINENUM or *ADDR, where ADDR is an expression\n\
3346 for an address to start at."));
3347 set_cmd_completer (jump_cmd, location_completer);
3348 add_com_alias ("j", jump_cmd, class_run, 1);
3349
3350 cmd_list_element *continue_cmd
3351 = add_com ("continue", class_run, continue_command, _("\
3352 Continue program being debugged, after signal or breakpoint.\n\
3353 Usage: continue [N]\n\
3354 If proceeding from breakpoint, a number N may be used as an argument,\n\
3355 which means to set the ignore count of that breakpoint to N - 1 (so that\n\
3356 the breakpoint won't break until the Nth time it is reached).\n\
3357 \n\
3358 If non-stop mode is enabled, continue only the current thread,\n\
3359 otherwise all the threads in the program are continued. To \n\
3360 continue all stopped threads in non-stop mode, use the -a option.\n\
3361 Specifying -a and an ignore count simultaneously is an error."));
3362 add_com_alias ("c", continue_cmd, class_run, 1);
3363 add_com_alias ("fg", continue_cmd, class_run, 1);
3364
3365 cmd_list_element *run_cmd
3366 = add_com ("run", class_run, run_command, _("\
3367 Start debugged program.\n"
3368 RUN_ARGS_HELP));
3369 set_cmd_completer (run_cmd, filename_completer);
3370 add_com_alias ("r", run_cmd, class_run, 1);
3371
3372 c = add_com ("start", class_run, start_command, _("\
3373 Start the debugged program stopping at the beginning of the main procedure.\n"
3374 RUN_ARGS_HELP));
3375 set_cmd_completer (c, filename_completer);
3376
3377 c = add_com ("starti", class_run, starti_command, _("\
3378 Start the debugged program stopping at the first instruction.\n"
3379 RUN_ARGS_HELP));
3380 set_cmd_completer (c, filename_completer);
3381
3382 add_com ("interrupt", class_run, interrupt_command,
3383 _("Interrupt the execution of the debugged program.\n\
3384 If non-stop mode is enabled, interrupt only the current thread,\n\
3385 otherwise all the threads in the program are stopped. To \n\
3386 interrupt all running threads in non-stop mode, use the -a option."));
3387
3388 cmd_list_element *info_registers_cmd
3389 = add_info ("registers", info_registers_command, _("\
3390 List of integer registers and their contents, for selected stack frame.\n\
3391 One or more register names as argument means describe the given registers.\n\
3392 One or more register group names as argument means describe the registers\n\
3393 in the named register groups."));
3394 add_info_alias ("r", info_registers_cmd, 1);
3395 set_cmd_completer (info_registers_cmd, reg_or_group_completer);
3396
3397 c = add_info ("all-registers", info_all_registers_command, _("\
3398 List of all registers and their contents, for selected stack frame.\n\
3399 One or more register names as argument means describe the given registers.\n\
3400 One or more register group names as argument means describe the registers\n\
3401 in the named register groups."));
3402 set_cmd_completer (c, reg_or_group_completer);
3403
3404 add_info ("program", info_program_command,
3405 _("Execution status of the program."));
3406
3407 add_info ("float", info_float_command,
3408 _("Print the status of the floating point unit."));
3409
3410 add_info ("vector", info_vector_command,
3411 _("Print the status of the vector unit."));
3412
3413 add_prefix_cmd ("proc", class_info, info_proc_cmd,
3414 _("\
3415 Show additional information about a process.\n\
3416 Specify any process id, or use the program being debugged by default."),
3417 &info_proc_cmdlist,
3418 1/*allow-unknown*/, &infolist);
3419
3420 add_cmd ("mappings", class_info, info_proc_cmd_mappings, _("\
3421 List memory regions mapped by the specified process."),
3422 &info_proc_cmdlist);
3423
3424 add_cmd ("stat", class_info, info_proc_cmd_stat, _("\
3425 List process info from /proc/PID/stat."),
3426 &info_proc_cmdlist);
3427
3428 add_cmd ("status", class_info, info_proc_cmd_status, _("\
3429 List process info from /proc/PID/status."),
3430 &info_proc_cmdlist);
3431
3432 add_cmd ("cwd", class_info, info_proc_cmd_cwd, _("\
3433 List current working directory of the specified process."),
3434 &info_proc_cmdlist);
3435
3436 add_cmd ("cmdline", class_info, info_proc_cmd_cmdline, _("\
3437 List command line arguments of the specified process."),
3438 &info_proc_cmdlist);
3439
3440 add_cmd ("exe", class_info, info_proc_cmd_exe, _("\
3441 List absolute filename for executable of the specified process."),
3442 &info_proc_cmdlist);
3443
3444 add_cmd ("files", class_info, info_proc_cmd_files, _("\
3445 List files opened by the specified process."),
3446 &info_proc_cmdlist);
3447
3448 add_cmd ("all", class_info, info_proc_cmd_all, _("\
3449 List all available info about the specified process."),
3450 &info_proc_cmdlist);
3451
3452 add_setshow_boolean_cmd ("finish", class_support,
3453 &finish_print, _("\
3454 Set whether `finish' prints the return value."), _("\
3455 Show whether `finish' prints the return value."), nullptr,
3456 nullptr,
3457 show_print_finish,
3458 &setprintlist, &showprintlist);
3459 }