5b6d1e4fa4
This commit adds multi-target support to GDB. What this means is that with this commit, GDB can now be connected to different targets at the same time. E.g., you can debug a live native process and a core dump at the same time, connect to multiple gdbservers, etc. Actually, the word "target" is overloaded in gdb. We already have a target stack, with pushes several target_ops instances on top of one another. We also have "info target" already, which means something completely different to what this patch does. So from here on, I'll be using the "target connections" term, to mean an open process_stratum target, pushed on a target stack. This patch makes gdb have multiple target stacks, and multiple process_stratum targets open simultaneously. The user-visible changes / commands will also use this terminology, but of course it's all open to debate. User-interface-wise, not that much changes. The main difference is that each inferior may have its own target connection. A target connection (e.g., a target extended-remote connection) may support debugging multiple processes, just as before. Say you're debugging against gdbserver in extended-remote mode, and you do "add-inferior" to prepare to spawn a new process, like: (gdb) target extended-remote :9999 ... (gdb) start ... (gdb) add-inferior Added inferior 2 (gdb) inferior 2 [Switching to inferior 2 [<null>] (<noexec>)] (gdb) file a.out ... (gdb) start ... At this point, you have two inferiors connected to the same gdbserver. With this commit, GDB will maintain a target stack per inferior, instead of a global target stack. To preserve the behavior above, by default, "add-inferior" makes the new inferior inherit a copy of the target stack of the current inferior. Same across a fork - the child inherits a copy of the target stack of the parent. While the target stacks are copied, the targets themselves are not. Instead, target_ops is made a refcounted_object, which means that target_ops instances are refcounted, which each inferior counting for a reference. What if you want to create an inferior and connect it to some _other_ target? For that, this commit introduces a new "add-inferior -no-connection" option that makes the new inferior not share the current inferior's target. So you could do: (gdb) target extended-remote :9999 Remote debugging using :9999 ... (gdb) add-inferior -no-connection [New inferior 2] Added inferior 2 (gdb) inferior 2 [Switching to inferior 2 [<null>] (<noexec>)] (gdb) info inferiors Num Description Executable 1 process 18401 target:/home/pedro/tmp/main * 2 <null> (gdb) tar extended-remote :10000 Remote debugging using :10000 ... (gdb) info inferiors Num Description Executable 1 process 18401 target:/home/pedro/tmp/main * 2 process 18450 target:/home/pedro/tmp/main (gdb) A following patch will extended "info inferiors" to include a column indicating which connection an inferior is bound to, along with a couple other UI tweaks. Other than that, debugging is the same as before. Users interact with inferiors and threads as before. The only difference is that inferiors may be bound to processes running in different machines. That's pretty much all there is to it in terms of noticeable UI changes. On to implementation. Since we can be connected to different systems at the same time, a ptid_t is no longer a unique identifier. Instead a thread can be identified by a pair of ptid_t and 'process_stratum_target *', the later being the instance of the process_stratum target that owns the process/thread. Note that process_stratum_target inherits from target_ops, and all process_stratum targets inherit from process_stratum_target. In earlier patches, many places in gdb were converted to refer to threads by thread_info pointer instead of ptid_t, but there are still places in gdb where we start with a pid/tid and need to find the corresponding inferior or thread_info objects. So you'll see in the patch many places adding a process_stratum_target parameter to functions that used to take only a ptid_t. Since each inferior has its own target stack now, we can always find the process_stratum target for an inferior. That is done via a inf->process_target() convenience method. Since each inferior has its own target stack, we need to handle the "beneath" calls when servicing target calls. The solution I settled with is just to make sure to switch the current inferior to the inferior you want before making a target call. Not relying on global context is just not feasible in current GDB. Fortunately, there aren't that many places that need to do that, because generally most code that calls target methods already has the current context pointing to the right inferior/thread. Note, to emphasize -- there's no method to "switch to this target stack". Instead, you switch the current inferior, and that implicitly switches the target stack. In some spots, we need to iterate over all inferiors so that we reach all target stacks. Native targets are still singletons. There's always only a single instance of such targets. Remote targets however, we'll have one instance per remote connection. The exec target is still a singleton. There's only one instance. I did not see the point of instanciating more than one exec_target object. After vfork, we need to make sure to push the exec target on the new inferior. See exec_on_vfork. For type safety, functions that need a {target, ptid} pair to identify a thread, take a process_stratum_target pointer for target parameter instead of target_ops *. Some shared code in gdb/nat/ also need to gain a target pointer parameter. This poses an issue, since gdbserver doesn't have process_stratum_target, only target_ops. To fix this, this commit renames gdbserver's target_ops to process_stratum_target. I think this makes sense. There's no concept of target stack in gdbserver, and gdbserver's target_ops really implements a process_stratum-like target. The thread and inferior iterator functions also gain process_stratum_target parameters. These are used to be able to iterate over threads and inferiors of a given target. Following usual conventions, if the target pointer is null, then we iterate over threads and inferiors of all targets. I tried converting "add-inferior" to the gdb::option framework, as a preparatory patch, but that stumbled on the fact that gdb::option does not support file options yet, for "add-inferior -exec". I have a WIP patchset that adds that, but it's not a trivial patch, mainly due to need to integrate readline's filename completion, so I deferred that to some other time. In infrun.c/infcmd.c, the main change is that we need to poll events out of all targets. See do_target_wait. Right after collecting an event, we switch the current inferior to an inferior bound to the target that reported the event, so that target methods can be used while handling the event. This makes most of the code transparent to multi-targets. See fetch_inferior_event. infrun.c:stop_all_threads is interesting -- in this function we need to stop all threads of all targets. What the function does is send an asynchronous stop request to all threads, and then synchronously waits for events, with target_wait, rinse repeat, until all it finds are stopped threads. Now that we have multiple targets, it's not efficient to synchronously block in target_wait waiting for events out of one target. Instead, we implement a mini event loop, with interruptible_select, select'ing on one file descriptor per target. For this to work, we need to be able to ask the target for a waitable file descriptor. Such file descriptors already exist, they are the descriptors registered in the main event loop with add_file_handler, inside the target_async implementations. This commit adds a new target_async_wait_fd target method that just returns the file descriptor in question. See wait_one / stop_all_threads in infrun.c. The 'threads_executing' global is made a per-target variable. Since it is only relevant to process_stratum_target targets, this is where it is put, instead of in target_ops. You'll notice that remote.c includes some FIXME notes. These refer to the fact that the global arrays that hold data for the remote packets supported are still globals. For example, if we connect to two different servers/stubs, then each might support different remote protocol features. They might even be different architectures, like e.g., one ARM baremetal stub, and a x86 gdbserver, to debug a host/controller scenario as a single program. That isn't going to work correctly today, because of said globals. I'm leaving fixing that for another pass, since it does not appear to be trivial, and I'd rather land the base work first. It's already useful to be able to debug multiple instances of the same server (e.g., a distributed cluster, where you have full control over the servers installed), so I think as is it's already reasonable incremental progress. Current limitations: - You can only resume more that one target at the same time if all targets support asynchronous debugging, and support non-stop mode. It should be possible to support mixed all-stop + non-stop backends, but that is left for another time. This means that currently in order to do multi-target with gdbserver you need to issue "maint set target-non-stop on". I would like to make that mode be the default, but we're not there yet. Note that I'm talking about how the target backend works, only. User-visible all-stop mode works just fine. - As explained above, connecting to different remote servers at the same time is likely to produce bad results if they don't support the exact set of RSP features. FreeBSD updates courtesy of John Baldwin. gdb/ChangeLog: 2020-01-10 Pedro Alves <palves@redhat.com> John Baldwin <jhb@FreeBSD.org> * aarch64-linux-nat.c (aarch64_linux_nat_target::thread_architecture): Adjust. * ada-tasks.c (print_ada_task_info): Adjust find_thread_ptid call. (task_command_1): Likewise. * aix-thread.c (sync_threadlists, aix_thread_target::resume) (aix_thread_target::wait, aix_thread_target::fetch_registers) (aix_thread_target::store_registers) (aix_thread_target::thread_alive): Adjust. * amd64-fbsd-tdep.c: Include "inferior.h". (amd64fbsd_get_thread_local_address): Pass down target. * amd64-linux-nat.c (ps_get_thread_area): Use ps_prochandle thread's gdbarch instead of target_gdbarch. * break-catch-sig.c (signal_catchpoint_print_it): Adjust call to get_last_target_status. * break-catch-syscall.c (print_it_catch_syscall): Likewise. * breakpoint.c (breakpoints_should_be_inserted_now): Consider all inferiors. (update_inserted_breakpoint_locations): Skip if inferiors with no execution. (update_global_location_list): When handling moribund locations, find representative inferior for location's pspace, and use thread count of its process_stratum target. * bsd-kvm.c (bsd_kvm_target_open): Pass target down. * bsd-uthread.c (bsd_uthread_target::wait): Use as_process_stratum_target and adjust thread_change_ptid and add_thread calls. (bsd_uthread_target::update_thread_list): Use as_process_stratum_target and adjust find_thread_ptid, thread_change_ptid and add_thread calls. * btrace.c (maint_btrace_packet_history_cmd): Adjust find_thread_ptid call. * corelow.c (add_to_thread_list): Adjust add_thread call. (core_target_open): Adjust add_thread_silent and thread_count calls. (core_target::pid_to_str): Adjust find_inferior_ptid call. * ctf.c (ctf_target_open): Adjust add_thread_silent call. * event-top.c (async_disconnect): Pop targets from all inferiors. * exec.c (add_target_sections): Push exec target on all inferiors sharing the program space. (remove_target_sections): Remove the exec target from all inferiors sharing the program space. (exec_on_vfork): New. * exec.h (exec_on_vfork): Declare. * fbsd-nat.c (fbsd_add_threads): Add fbsd_nat_target parameter. Pass it down. (fbsd_nat_target::update_thread_list): Adjust. (fbsd_nat_target::resume): Adjust. (fbsd_handle_debug_trap): Add fbsd_nat_target parameter. Pass it down. (fbsd_nat_target::wait, fbsd_nat_target::post_attach): Adjust. * fbsd-tdep.c (fbsd_corefile_thread): Adjust get_thread_arch_regcache call. * fork-child.c (gdb_startup_inferior): Pass target down to startup_inferior and set_executing. * gdbthread.h (struct process_stratum_target): Forward declare. (add_thread, add_thread_silent, add_thread_with_info) (in_thread_list): Add process_stratum_target parameter. (find_thread_ptid(inferior*, ptid_t)): New overload. (find_thread_ptid, thread_change_ptid): Add process_stratum_target parameter. (all_threads()): Delete overload. (all_threads, all_non_exited_threads): Add process_stratum_target parameter. (all_threads_safe): Use brace initialization. (thread_count): Add process_stratum_target parameter. (set_resumed, set_running, set_stop_requested, set_executing) (threads_are_executing, finish_thread_state): Add process_stratum_target parameter. (switch_to_thread): Use is_current_thread. * i386-fbsd-tdep.c: Include "inferior.h". (i386fbsd_get_thread_local_address): Pass down target. * i386-linux-nat.c (i386_linux_nat_target::low_resume): Adjust. * inf-child.c (inf_child_target::maybe_unpush_target): Remove have_inferiors check. * inf-ptrace.c (inf_ptrace_target::create_inferior) (inf_ptrace_target::attach): Adjust. * infcall.c (run_inferior_call): Adjust. * infcmd.c (run_command_1): Pass target to scoped_finish_thread_state. (proceed_thread_callback): Skip inferiors with no execution. (continue_command): Rename 'all_threads' local to avoid hiding 'all_threads' function. Adjust get_last_target_status call. (prepare_one_step): Adjust set_running call. (signal_command): Use user_visible_resume_target. Compare thread pointers instead of inferior_ptid. (info_program_command): Adjust to pass down target. (attach_command): Mark target's 'thread_executing' flag. (stop_current_target_threads_ns): New, factored out from ... (interrupt_target_1): ... this. Switch inferior before making target calls. * inferior-iter.h (struct all_inferiors_iterator, struct all_inferiors_range) (struct all_inferiors_safe_range) (struct all_non_exited_inferiors_range): Filter on process_stratum_target too. Remove explicit. * inferior.c (inferior::inferior): Push dummy target on target stack. (find_inferior_pid, find_inferior_ptid, number_of_live_inferiors): Add process_stratum_target parameter, and pass it down. (have_live_inferiors): Adjust. (switch_to_inferior_and_push_target): New. (add_inferior_command, clone_inferior_command): Handle "-no-connection" parameter. Use switch_to_inferior_and_push_target. (_initialize_inferior): Mention "-no-connection" option in the help of "add-inferior" and "clone-inferior" commands. * inferior.h: Include "process-stratum-target.h". (interrupt_target_1): Use bool. (struct inferior) <push_target, unpush_target, target_is_pushed, find_target_beneath, top_target, process_target, target_at, m_stack>: New. (discard_all_inferiors): Delete. (find_inferior_pid, find_inferior_ptid, number_of_live_inferiors) (all_inferiors, all_non_exited_inferiors): Add process_stratum_target parameter. * infrun.c: Include "gdb_select.h" and <unordered_map>. (target_last_proc_target): New global. (follow_fork_inferior): Push target on new inferior. Pass target to add_thread_silent. Call exec_on_vfork. Handle target's reference count. (follow_fork): Adjust get_last_target_status call. Also consider target. (follow_exec): Push target on new inferior. (struct execution_control_state) <target>: New field. (user_visible_resume_target): New. (do_target_resume): Call target_async. (resume_1): Set target's threads_executing flag. Consider resume target. (commit_resume_all_targets): New. (proceed): Also consider resume target. Skip threads of inferiors with no execution. Commit resumtion in all targets. (start_remote): Pass current inferior to wait_for_inferior. (infrun_thread_stop_requested): Consider target as well. Pass thread_info pointer to clear_inline_frame_state instead of ptid. (infrun_thread_thread_exit): Consider target as well. (random_pending_event_thread): New inferior parameter. Use it. (do_target_wait): Rename to ... (do_target_wait_1): ... this. Add inferior parameter, and pass it down. (threads_are_resumed_pending_p, do_target_wait): New. (prepare_for_detach): Adjust calls. (wait_for_inferior): New inferior parameter. Handle it. Use do_target_wait_1 instead of do_target_wait. (fetch_inferior_event): Adjust. Switch to representative inferior. Pass target down. (set_last_target_status): Add process_stratum_target parameter. Save target in global. (get_last_target_status): Add process_stratum_target parameter and handle it. (nullify_last_target_wait_ptid): Clear 'target_last_proc_target'. (context_switch): Check inferior_ptid == null_ptid before calling inferior_thread(). (get_inferior_stop_soon): Pass down target. (wait_one): Rename to ... (poll_one_curr_target): ... this. (struct wait_one_event): New. (wait_one): New. (stop_all_threads): Adjust. (handle_no_resumed, handle_inferior_event): Adjust to consider the event's target. (switch_back_to_stepped_thread): Also consider target. (print_stop_event): Update. (normal_stop): Update. Also consider the resume target. * infrun.h (wait_for_inferior): Remove declaration. (user_visible_resume_target): New declaration. (get_last_target_status, set_last_target_status): New process_stratum_target parameter. * inline-frame.c (clear_inline_frame_state(ptid_t)): Add process_stratum_target parameter, and use it. (clear_inline_frame_state (thread_info*)): New. * inline-frame.c (clear_inline_frame_state(ptid_t)): Add process_stratum_target parameter. (clear_inline_frame_state (thread_info*)): Declare. * linux-fork.c (delete_checkpoint_command): Pass target down to find_thread_ptid. (checkpoint_command): Adjust. * linux-nat.c (linux_nat_target::follow_fork): Switch to thread instead of just tweaking inferior_ptid. (linux_nat_switch_fork): Pass target down to thread_change_ptid. (exit_lwp): Pass target down to find_thread_ptid. (attach_proc_task_lwp_callback): Pass target down to add_thread/set_running/set_executing. (linux_nat_target::attach): Pass target down to thread_change_ptid. (get_detach_signal): Pass target down to find_thread_ptid. Consider last target status's target. (linux_resume_one_lwp_throw, resume_lwp) (linux_handle_syscall_trap, linux_handle_extended_wait, wait_lwp) (stop_wait_callback, save_stop_reason, linux_nat_filter_event) (linux_nat_wait_1, resume_stopped_resumed_lwps): Pass target down. (linux_nat_target::async_wait_fd): New. (linux_nat_stop_lwp, linux_nat_target::thread_address_space): Pass target down. * linux-nat.h (linux_nat_target::async_wait_fd): Declare. * linux-tdep.c (get_thread_arch_regcache): Pass target down. * linux-thread-db.c (struct thread_db_info::process_target): New field. (add_thread_db_info): Save target. (get_thread_db_info): New process_stratum_target parameter. Also match target. (delete_thread_db_info): New process_stratum_target parameter. Also match target. (thread_from_lwp): Adjust to pass down target. (thread_db_notice_clone): Pass down target. (check_thread_db_callback): Pass down target. (try_thread_db_load_1): Always push the thread_db target. (try_thread_db_load, record_thread): Pass target down. (thread_db_target::detach): Pass target down. Always unpush the thread_db target. (thread_db_target::wait, thread_db_target::mourn_inferior): Pass target down. Always unpush the thread_db target. (find_new_threads_callback, thread_db_find_new_threads_2) (thread_db_target::update_thread_list): Pass target down. (thread_db_target::pid_to_str): Pass current inferior down. (thread_db_target::get_thread_local_address): Pass target down. (thread_db_target::resume, maintenance_check_libthread_db): Pass target down. * nto-procfs.c (nto_procfs_target::update_thread_list): Adjust. * procfs.c (procfs_target::procfs_init_inferior): Declare. (proc_set_current_signal, do_attach, procfs_target::wait): Adjust. (procfs_init_inferior): Rename to ... (procfs_target::procfs_init_inferior): ... this and adjust. (procfs_target::create_inferior, procfs_notice_thread) (procfs_do_thread_registers): Adjust. * ppc-fbsd-tdep.c: Include "inferior.h". (ppcfbsd_get_thread_local_address): Pass down target. * proc-service.c (ps_xfer_memory): Switch current inferior and program space as well. (get_ps_regcache): Pass target down. * process-stratum-target.c (process_stratum_target::thread_address_space) (process_stratum_target::thread_architecture): Pass target down. * process-stratum-target.h (process_stratum_target::threads_executing): New field. (as_process_stratum_target): New. * ravenscar-thread.c (ravenscar_thread_target::update_inferior_ptid): Pass target down. (ravenscar_thread_target::wait, ravenscar_add_thread): Pass target down. * record-btrace.c (record_btrace_target::info_record): Adjust. (record_btrace_target::record_method) (record_btrace_target::record_is_replaying) (record_btrace_target::fetch_registers) (get_thread_current_frame_id, record_btrace_target::resume) (record_btrace_target::wait, record_btrace_target::stop): Pass target down. * record-full.c (record_full_wait_1): Switch to event thread. Pass target down. * regcache.c (regcache::regcache) (get_thread_arch_aspace_regcache, get_thread_arch_regcache): Add process_stratum_target parameter and handle it. (current_thread_target): New global. (get_thread_regcache): Add process_stratum_target parameter and handle it. Switch inferior before calling target method. (get_thread_regcache): Pass target down. (get_thread_regcache_for_ptid): Pass target down. (registers_changed_ptid): Add process_stratum_target parameter and handle it. (registers_changed_thread, registers_changed): Pass target down. (test_get_thread_arch_aspace_regcache): New. (current_regcache_test): Define a couple local test_target_ops instances and use them for testing. (readwrite_regcache): Pass process_stratum_target parameter. (cooked_read_test, cooked_write_test): Pass mock_target down. * regcache.h (get_thread_regcache, get_thread_arch_regcache) (get_thread_arch_aspace_regcache): Add process_stratum_target parameter. (regcache::target): New method. (regcache::regcache, regcache::get_thread_arch_aspace_regcache) (regcache::registers_changed_ptid): Add process_stratum_target parameter. (regcache::m_target): New field. (registers_changed_ptid): Add process_stratum_target parameter. * remote.c (remote_state::supports_vCont_probed): New field. (remote_target::async_wait_fd): New method. (remote_unpush_and_throw): Add remote_target parameter. (get_current_remote_target): Adjust. (remote_target::remote_add_inferior): Push target. (remote_target::remote_add_thread) (remote_target::remote_notice_new_inferior) (get_remote_thread_info): Pass target down. (remote_target::update_thread_list): Skip threads of inferiors bound to other targets. (remote_target::close): Don't discard inferiors. (remote_target::add_current_inferior_and_thread) (remote_target::process_initial_stop_replies) (remote_target::start_remote) (remote_target::remote_serial_quit_handler): Pass down target. (remote_target::remote_unpush_target): New remote_target parameter. Unpush the target from all inferiors. (remote_target::remote_unpush_and_throw): New remote_target parameter. Pass it down. (remote_target::open_1): Check whether the current inferior has execution instead of checking whether any inferior is live. Pass target down. (remote_target::remote_detach_1): Pass down target. Use remote_unpush_target. (extended_remote_target::attach): Pass down target. (remote_target::remote_vcont_probe): Set supports_vCont_probed. (remote_target::append_resumption): Pass down target. (remote_target::append_pending_thread_resumptions) (remote_target::remote_resume_with_hc, remote_target::resume) (remote_target::commit_resume): Pass down target. (remote_target::remote_stop_ns): Check supports_vCont_probed. (remote_target::interrupt_query) (remote_target::remove_new_fork_children) (remote_target::check_pending_events_prevent_wildcard_vcont) (remote_target::remote_parse_stop_reply) (remote_target::process_stop_reply): Pass down target. (first_remote_resumed_thread): New remote_target parameter. Pass it down. (remote_target::wait_as): Pass down target. (unpush_and_perror): New remote_target parameter. Pass it down. (remote_target::readchar, remote_target::remote_serial_write) (remote_target::getpkt_or_notif_sane_1) (remote_target::kill_new_fork_children, remote_target::kill): Pass down target. (remote_target::mourn_inferior): Pass down target. Use remote_unpush_target. (remote_target::core_of_thread) (remote_target::remote_btrace_maybe_reopen): Pass down target. (remote_target::pid_to_exec_file) (remote_target::thread_handle_to_thread_info): Pass down target. (remote_target::async_wait_fd): New. * riscv-fbsd-tdep.c: Include "inferior.h". (riscv_fbsd_get_thread_local_address): Pass down target. * sol2-tdep.c (sol2_core_pid_to_str): Pass down target. * sol-thread.c (sol_thread_target::wait, ps_lgetregs, ps_lsetregs) (ps_lgetfpregs, ps_lsetfpregs, sol_update_thread_list_callback): Adjust. * solib-spu.c (spu_skip_standalone_loader): Pass down target. * solib-svr4.c (enable_break): Pass down target. * spu-multiarch.c (parse_spufs_run): Pass down target. * spu-tdep.c (spu2ppu_sniffer): Pass down target. * target-delegates.c: Regenerate. * target.c (g_target_stack): Delete. (current_top_target): Return the current inferior's top target. (target_has_execution_1): Refer to the passed-in inferior's top target. (target_supports_terminal_ours): Check whether the initial inferior was already created. (decref_target): New. (target_stack::push): Incref/decref the target. (push_target, push_target, unpush_target): Adjust. (target_stack::unpush): Defref target. (target_is_pushed): Return bool. Adjust to refer to the current inferior's target stack. (dispose_inferior): Delete, and inline parts ... (target_preopen): ... here. Only dispose of the current inferior. (target_detach): Hold strong target reference while detaching. Pass target down. (target_thread_name): Add assertion. (target_resume): Pass down target. (target_ops::beneath, find_target_at): Adjust to refer to the current inferior's target stack. (get_dummy_target): New. (target_pass_ctrlc): Pass the Ctrl-C to the first inferior that has a thread running. (initialize_targets): Rename to ... (_initialize_target): ... this. * target.h: Include "gdbsupport/refcounted-object.h". (struct target_ops): Inherit refcounted_object. (target_ops::shortname, target_ops::longname): Make const. (target_ops::async_wait_fd): New method. (decref_target): Declare. (struct target_ops_ref_policy): New. (target_ops_ref): New typedef. (get_dummy_target): Declare function. (target_is_pushed): Return bool. * thread-iter.c (all_matching_threads_iterator::m_inf_matches) (all_matching_threads_iterator::all_matching_threads_iterator): Handle filter target. * thread-iter.h (struct all_matching_threads_iterator, struct all_matching_threads_range, class all_non_exited_threads_range): Filter by target too. Remove explicit. * thread.c (threads_executing): Delete. (inferior_thread): Pass down current inferior. (clear_thread_inferior_resources): Pass down thread pointer instead of ptid_t. (add_thread_silent, add_thread_with_info, add_thread): Add process_stratum_target parameter. Use it for thread and inferior searches. (is_current_thread): New. (thread_info::deletable): Use it. (find_thread_ptid, thread_count, in_thread_list) (thread_change_ptid, set_resumed, set_running): New process_stratum_target parameter. Pass it down. (set_executing): New process_stratum_target parameter. Pass it down. Adjust reference to 'threads_executing'. (threads_are_executing): New process_stratum_target parameter. Adjust reference to 'threads_executing'. (set_stop_requested, finish_thread_state): New process_stratum_target parameter. Pass it down. (switch_to_thread): Also match inferior. (switch_to_thread): New process_stratum_target parameter. Pass it down. (update_threads_executing): Reimplement. * top.c (quit_force): Pop targets from all inferior. (gdb_init): Don't call initialize_targets. * windows-nat.c (windows_nat_target) <get_windows_debug_event>: Declare. (windows_add_thread, windows_delete_thread): Adjust. (get_windows_debug_event): Rename to ... (windows_nat_target::get_windows_debug_event): ... this. Adjust. * tracefile-tfile.c (tfile_target_open): Pass down target. * gdbsupport/common-gdbthread.h (struct process_stratum_target): Forward declare. (switch_to_thread): Add process_stratum_target parameter. * mi/mi-interp.c (mi_on_resume_1): Add process_stratum_target parameter. Use it. (mi_on_resume): Pass target down. * nat/fork-inferior.c (startup_inferior): Add process_stratum_target parameter. Pass it down. * nat/fork-inferior.h (startup_inferior): Add process_stratum_target parameter. * python/py-threadevent.c (py_get_event_thread): Pass target down. gdb/gdbserver/ChangeLog: 2020-01-10 Pedro Alves <palves@redhat.com> * fork-child.c (post_fork_inferior): Pass target down to startup_inferior. * inferiors.c (switch_to_thread): Add process_stratum_target parameter. * lynx-low.c (lynx_target_ops): Now a process_stratum_target. * nto-low.c (nto_target_ops): Now a process_stratum_target. * linux-low.c (linux_target_ops): Now a process_stratum_target. * remote-utils.c (prepare_resume_reply): Pass the target to switch_to_thread. * target.c (the_target): Now a process_stratum_target. (done_accessing_memory): Pass the target to switch_to_thread. (set_target_ops): Ajust to use process_stratum_target. * target.h (struct target_ops): Rename to ... (struct process_stratum_target): ... this. (the_target, set_target_ops): Adjust. (prepare_to_access_memory): Adjust comment. * win32-low.c (child_xfer_memory): Adjust to use process_stratum_target. (win32_target_ops): Now a process_stratum_target.
1567 lines
53 KiB
C
1567 lines
53 KiB
C
/* Perform an inferior function call, for GDB, the GNU debugger.
|
|
|
|
Copyright (C) 1986-2020 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#include "defs.h"
|
|
#include "infcall.h"
|
|
#include "breakpoint.h"
|
|
#include "tracepoint.h"
|
|
#include "target.h"
|
|
#include "regcache.h"
|
|
#include "inferior.h"
|
|
#include "infrun.h"
|
|
#include "block.h"
|
|
#include "gdbcore.h"
|
|
#include "language.h"
|
|
#include "objfiles.h"
|
|
#include "gdbcmd.h"
|
|
#include "command.h"
|
|
#include "dummy-frame.h"
|
|
#include "ada-lang.h"
|
|
#include "f-lang.h"
|
|
#include "gdbthread.h"
|
|
#include "event-top.h"
|
|
#include "observable.h"
|
|
#include "top.h"
|
|
#include "interps.h"
|
|
#include "thread-fsm.h"
|
|
#include <algorithm>
|
|
#include "gdbsupport/scope-exit.h"
|
|
#include <list>
|
|
|
|
/* If we can't find a function's name from its address,
|
|
we print this instead. */
|
|
#define RAW_FUNCTION_ADDRESS_FORMAT "at 0x%s"
|
|
#define RAW_FUNCTION_ADDRESS_SIZE (sizeof (RAW_FUNCTION_ADDRESS_FORMAT) \
|
|
+ 2 * sizeof (CORE_ADDR))
|
|
|
|
/* NOTE: cagney/2003-04-16: What's the future of this code?
|
|
|
|
GDB needs an asynchronous expression evaluator, that means an
|
|
asynchronous inferior function call implementation, and that in
|
|
turn means restructuring the code so that it is event driven. */
|
|
|
|
static bool may_call_functions_p = true;
|
|
static void
|
|
show_may_call_functions_p (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c,
|
|
const char *value)
|
|
{
|
|
fprintf_filtered (file,
|
|
_("Permission to call functions in the program is %s.\n"),
|
|
value);
|
|
}
|
|
|
|
/* How you should pass arguments to a function depends on whether it
|
|
was defined in K&R style or prototype style. If you define a
|
|
function using the K&R syntax that takes a `float' argument, then
|
|
callers must pass that argument as a `double'. If you define the
|
|
function using the prototype syntax, then you must pass the
|
|
argument as a `float', with no promotion.
|
|
|
|
Unfortunately, on certain older platforms, the debug info doesn't
|
|
indicate reliably how each function was defined. A function type's
|
|
TYPE_PROTOTYPED flag may be clear, even if the function was defined
|
|
in prototype style. When calling a function whose TYPE_PROTOTYPED
|
|
flag is clear, GDB consults this flag to decide what to do.
|
|
|
|
For modern targets, it is proper to assume that, if the prototype
|
|
flag is clear, that can be trusted: `float' arguments should be
|
|
promoted to `double'. For some older targets, if the prototype
|
|
flag is clear, that doesn't tell us anything. The default is to
|
|
trust the debug information; the user can override this behavior
|
|
with "set coerce-float-to-double 0". */
|
|
|
|
static bool coerce_float_to_double_p = true;
|
|
static void
|
|
show_coerce_float_to_double_p (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c, const char *value)
|
|
{
|
|
fprintf_filtered (file,
|
|
_("Coercion of floats to doubles "
|
|
"when calling functions is %s.\n"),
|
|
value);
|
|
}
|
|
|
|
/* This boolean tells what gdb should do if a signal is received while
|
|
in a function called from gdb (call dummy). If set, gdb unwinds
|
|
the stack and restore the context to what as it was before the
|
|
call.
|
|
|
|
The default is to stop in the frame where the signal was received. */
|
|
|
|
static bool unwind_on_signal_p = false;
|
|
static void
|
|
show_unwind_on_signal_p (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c, const char *value)
|
|
{
|
|
fprintf_filtered (file,
|
|
_("Unwinding of stack if a signal is "
|
|
"received while in a call dummy is %s.\n"),
|
|
value);
|
|
}
|
|
|
|
/* This boolean tells what gdb should do if a std::terminate call is
|
|
made while in a function called from gdb (call dummy).
|
|
As the confines of a single dummy stack prohibit out-of-frame
|
|
handlers from handling a raised exception, and as out-of-frame
|
|
handlers are common in C++, this can lead to no handler being found
|
|
by the unwinder, and a std::terminate call. This is a false positive.
|
|
If set, gdb unwinds the stack and restores the context to what it
|
|
was before the call.
|
|
|
|
The default is to unwind the frame if a std::terminate call is
|
|
made. */
|
|
|
|
static bool unwind_on_terminating_exception_p = true;
|
|
|
|
static void
|
|
show_unwind_on_terminating_exception_p (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c,
|
|
const char *value)
|
|
|
|
{
|
|
fprintf_filtered (file,
|
|
_("Unwind stack if a C++ exception is "
|
|
"unhandled while in a call dummy is %s.\n"),
|
|
value);
|
|
}
|
|
|
|
/* Perform the standard coercions that are specified
|
|
for arguments to be passed to C, Ada or Fortran functions.
|
|
|
|
If PARAM_TYPE is non-NULL, it is the expected parameter type.
|
|
IS_PROTOTYPED is non-zero if the function declaration is prototyped. */
|
|
|
|
static struct value *
|
|
value_arg_coerce (struct gdbarch *gdbarch, struct value *arg,
|
|
struct type *param_type, int is_prototyped)
|
|
{
|
|
const struct builtin_type *builtin = builtin_type (gdbarch);
|
|
struct type *arg_type = check_typedef (value_type (arg));
|
|
struct type *type
|
|
= param_type ? check_typedef (param_type) : arg_type;
|
|
|
|
/* Perform any Ada- and Fortran-specific coercion first. */
|
|
if (current_language->la_language == language_ada)
|
|
arg = ada_convert_actual (arg, type);
|
|
else if (current_language->la_language == language_fortran)
|
|
type = fortran_preserve_arg_pointer (arg, type);
|
|
|
|
/* Force the value to the target if we will need its address. At
|
|
this point, we could allocate arguments on the stack instead of
|
|
calling malloc if we knew that their addresses would not be
|
|
saved by the called function. */
|
|
arg = value_coerce_to_target (arg);
|
|
|
|
switch (TYPE_CODE (type))
|
|
{
|
|
case TYPE_CODE_REF:
|
|
case TYPE_CODE_RVALUE_REF:
|
|
{
|
|
struct value *new_value;
|
|
|
|
if (TYPE_IS_REFERENCE (arg_type))
|
|
return value_cast_pointers (type, arg, 0);
|
|
|
|
/* Cast the value to the reference's target type, and then
|
|
convert it back to a reference. This will issue an error
|
|
if the value was not previously in memory - in some cases
|
|
we should clearly be allowing this, but how? */
|
|
new_value = value_cast (TYPE_TARGET_TYPE (type), arg);
|
|
new_value = value_ref (new_value, TYPE_CODE (type));
|
|
return new_value;
|
|
}
|
|
case TYPE_CODE_INT:
|
|
case TYPE_CODE_CHAR:
|
|
case TYPE_CODE_BOOL:
|
|
case TYPE_CODE_ENUM:
|
|
/* If we don't have a prototype, coerce to integer type if necessary. */
|
|
if (!is_prototyped)
|
|
{
|
|
if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_int))
|
|
type = builtin->builtin_int;
|
|
}
|
|
/* Currently all target ABIs require at least the width of an integer
|
|
type for an argument. We may have to conditionalize the following
|
|
type coercion for future targets. */
|
|
if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_int))
|
|
type = builtin->builtin_int;
|
|
break;
|
|
case TYPE_CODE_FLT:
|
|
if (!is_prototyped && coerce_float_to_double_p)
|
|
{
|
|
if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_double))
|
|
type = builtin->builtin_double;
|
|
else if (TYPE_LENGTH (type) > TYPE_LENGTH (builtin->builtin_double))
|
|
type = builtin->builtin_long_double;
|
|
}
|
|
break;
|
|
case TYPE_CODE_FUNC:
|
|
type = lookup_pointer_type (type);
|
|
break;
|
|
case TYPE_CODE_ARRAY:
|
|
/* Arrays are coerced to pointers to their first element, unless
|
|
they are vectors, in which case we want to leave them alone,
|
|
because they are passed by value. */
|
|
if (current_language->c_style_arrays)
|
|
if (!TYPE_VECTOR (type))
|
|
type = lookup_pointer_type (TYPE_TARGET_TYPE (type));
|
|
break;
|
|
case TYPE_CODE_UNDEF:
|
|
case TYPE_CODE_PTR:
|
|
case TYPE_CODE_STRUCT:
|
|
case TYPE_CODE_UNION:
|
|
case TYPE_CODE_VOID:
|
|
case TYPE_CODE_SET:
|
|
case TYPE_CODE_RANGE:
|
|
case TYPE_CODE_STRING:
|
|
case TYPE_CODE_ERROR:
|
|
case TYPE_CODE_MEMBERPTR:
|
|
case TYPE_CODE_METHODPTR:
|
|
case TYPE_CODE_METHOD:
|
|
case TYPE_CODE_COMPLEX:
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return value_cast (type, arg);
|
|
}
|
|
|
|
/* See infcall.h. */
|
|
|
|
CORE_ADDR
|
|
find_function_addr (struct value *function,
|
|
struct type **retval_type,
|
|
struct type **function_type)
|
|
{
|
|
struct type *ftype = check_typedef (value_type (function));
|
|
struct gdbarch *gdbarch = get_type_arch (ftype);
|
|
struct type *value_type = NULL;
|
|
/* Initialize it just to avoid a GCC false warning. */
|
|
CORE_ADDR funaddr = 0;
|
|
|
|
/* If it's a member function, just look at the function
|
|
part of it. */
|
|
|
|
/* Determine address to call. */
|
|
if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
|
|
|| TYPE_CODE (ftype) == TYPE_CODE_METHOD)
|
|
funaddr = value_address (function);
|
|
else if (TYPE_CODE (ftype) == TYPE_CODE_PTR)
|
|
{
|
|
funaddr = value_as_address (function);
|
|
ftype = check_typedef (TYPE_TARGET_TYPE (ftype));
|
|
if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
|
|
|| TYPE_CODE (ftype) == TYPE_CODE_METHOD)
|
|
funaddr = gdbarch_convert_from_func_ptr_addr (gdbarch, funaddr,
|
|
current_top_target ());
|
|
}
|
|
if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
|
|
|| TYPE_CODE (ftype) == TYPE_CODE_METHOD)
|
|
{
|
|
if (TYPE_GNU_IFUNC (ftype))
|
|
{
|
|
CORE_ADDR resolver_addr = funaddr;
|
|
|
|
/* Resolve the ifunc. Note this may call the resolver
|
|
function in the inferior. */
|
|
funaddr = gnu_ifunc_resolve_addr (gdbarch, resolver_addr);
|
|
|
|
/* Skip querying the function symbol if no RETVAL_TYPE or
|
|
FUNCTION_TYPE have been asked for. */
|
|
if (retval_type != NULL || function_type != NULL)
|
|
{
|
|
type *target_ftype = find_function_type (funaddr);
|
|
/* If we don't have debug info for the target function,
|
|
see if we can instead extract the target function's
|
|
type from the type that the resolver returns. */
|
|
if (target_ftype == NULL)
|
|
target_ftype = find_gnu_ifunc_target_type (resolver_addr);
|
|
if (target_ftype != NULL)
|
|
{
|
|
value_type = TYPE_TARGET_TYPE (check_typedef (target_ftype));
|
|
ftype = target_ftype;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
value_type = TYPE_TARGET_TYPE (ftype);
|
|
}
|
|
else if (TYPE_CODE (ftype) == TYPE_CODE_INT)
|
|
{
|
|
/* Handle the case of functions lacking debugging info.
|
|
Their values are characters since their addresses are char. */
|
|
if (TYPE_LENGTH (ftype) == 1)
|
|
funaddr = value_as_address (value_addr (function));
|
|
else
|
|
{
|
|
/* Handle function descriptors lacking debug info. */
|
|
int found_descriptor = 0;
|
|
|
|
funaddr = 0; /* pacify "gcc -Werror" */
|
|
if (VALUE_LVAL (function) == lval_memory)
|
|
{
|
|
CORE_ADDR nfunaddr;
|
|
|
|
funaddr = value_as_address (value_addr (function));
|
|
nfunaddr = funaddr;
|
|
funaddr
|
|
= gdbarch_convert_from_func_ptr_addr (gdbarch, funaddr,
|
|
current_top_target ());
|
|
if (funaddr != nfunaddr)
|
|
found_descriptor = 1;
|
|
}
|
|
if (!found_descriptor)
|
|
/* Handle integer used as address of a function. */
|
|
funaddr = (CORE_ADDR) value_as_long (function);
|
|
}
|
|
}
|
|
else
|
|
error (_("Invalid data type for function to be called."));
|
|
|
|
if (retval_type != NULL)
|
|
*retval_type = value_type;
|
|
if (function_type != NULL)
|
|
*function_type = ftype;
|
|
return funaddr + gdbarch_deprecated_function_start_offset (gdbarch);
|
|
}
|
|
|
|
/* For CALL_DUMMY_ON_STACK, push a breakpoint sequence that the called
|
|
function returns to. */
|
|
|
|
static CORE_ADDR
|
|
push_dummy_code (struct gdbarch *gdbarch,
|
|
CORE_ADDR sp, CORE_ADDR funaddr,
|
|
gdb::array_view<value *> args,
|
|
struct type *value_type,
|
|
CORE_ADDR *real_pc, CORE_ADDR *bp_addr,
|
|
struct regcache *regcache)
|
|
{
|
|
gdb_assert (gdbarch_push_dummy_code_p (gdbarch));
|
|
|
|
return gdbarch_push_dummy_code (gdbarch, sp, funaddr,
|
|
args.data (), args.size (),
|
|
value_type, real_pc, bp_addr,
|
|
regcache);
|
|
}
|
|
|
|
/* See infcall.h. */
|
|
|
|
void
|
|
error_call_unknown_return_type (const char *func_name)
|
|
{
|
|
if (func_name != NULL)
|
|
error (_("'%s' has unknown return type; "
|
|
"cast the call to its declared return type"),
|
|
func_name);
|
|
else
|
|
error (_("function has unknown return type; "
|
|
"cast the call to its declared return type"));
|
|
}
|
|
|
|
/* Fetch the name of the function at FUNADDR.
|
|
This is used in printing an error message for call_function_by_hand.
|
|
BUF is used to print FUNADDR in hex if the function name cannot be
|
|
determined. It must be large enough to hold formatted result of
|
|
RAW_FUNCTION_ADDRESS_FORMAT. */
|
|
|
|
static const char *
|
|
get_function_name (CORE_ADDR funaddr, char *buf, int buf_size)
|
|
{
|
|
{
|
|
struct symbol *symbol = find_pc_function (funaddr);
|
|
|
|
if (symbol)
|
|
return symbol->print_name ();
|
|
}
|
|
|
|
{
|
|
/* Try the minimal symbols. */
|
|
struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (funaddr);
|
|
|
|
if (msymbol.minsym)
|
|
return msymbol.minsym->print_name ();
|
|
}
|
|
|
|
{
|
|
std::string tmp = string_printf (_(RAW_FUNCTION_ADDRESS_FORMAT),
|
|
hex_string (funaddr));
|
|
|
|
gdb_assert (tmp.length () + 1 <= buf_size);
|
|
return strcpy (buf, tmp.c_str ());
|
|
}
|
|
}
|
|
|
|
/* All the meta data necessary to extract the call's return value. */
|
|
|
|
struct call_return_meta_info
|
|
{
|
|
/* The caller frame's architecture. */
|
|
struct gdbarch *gdbarch;
|
|
|
|
/* The called function. */
|
|
struct value *function;
|
|
|
|
/* The return value's type. */
|
|
struct type *value_type;
|
|
|
|
/* Are we returning a value using a structure return or a normal
|
|
value return? */
|
|
int struct_return_p;
|
|
|
|
/* If using a structure return, this is the structure's address. */
|
|
CORE_ADDR struct_addr;
|
|
};
|
|
|
|
/* Extract the called function's return value. */
|
|
|
|
static struct value *
|
|
get_call_return_value (struct call_return_meta_info *ri)
|
|
{
|
|
struct value *retval = NULL;
|
|
thread_info *thr = inferior_thread ();
|
|
bool stack_temporaries = thread_stack_temporaries_enabled_p (thr);
|
|
|
|
if (TYPE_CODE (ri->value_type) == TYPE_CODE_VOID)
|
|
retval = allocate_value (ri->value_type);
|
|
else if (ri->struct_return_p)
|
|
{
|
|
if (stack_temporaries)
|
|
{
|
|
retval = value_from_contents_and_address (ri->value_type, NULL,
|
|
ri->struct_addr);
|
|
push_thread_stack_temporary (thr, retval);
|
|
}
|
|
else
|
|
{
|
|
retval = allocate_value (ri->value_type);
|
|
read_value_memory (retval, 0, 1, ri->struct_addr,
|
|
value_contents_raw (retval),
|
|
TYPE_LENGTH (ri->value_type));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
retval = allocate_value (ri->value_type);
|
|
gdbarch_return_value (ri->gdbarch, ri->function, ri->value_type,
|
|
get_current_regcache (),
|
|
value_contents_raw (retval), NULL);
|
|
if (stack_temporaries && class_or_union_p (ri->value_type))
|
|
{
|
|
/* Values of class type returned in registers are copied onto
|
|
the stack and their lval_type set to lval_memory. This is
|
|
required because further evaluation of the expression
|
|
could potentially invoke methods on the return value
|
|
requiring GDB to evaluate the "this" pointer. To evaluate
|
|
the this pointer, GDB needs the memory address of the
|
|
value. */
|
|
value_force_lval (retval, ri->struct_addr);
|
|
push_thread_stack_temporary (thr, retval);
|
|
}
|
|
}
|
|
|
|
gdb_assert (retval != NULL);
|
|
return retval;
|
|
}
|
|
|
|
/* Data for the FSM that manages an infcall. It's main job is to
|
|
record the called function's return value. */
|
|
|
|
struct call_thread_fsm : public thread_fsm
|
|
{
|
|
/* All the info necessary to be able to extract the return
|
|
value. */
|
|
struct call_return_meta_info return_meta_info;
|
|
|
|
/* The called function's return value. This is extracted from the
|
|
target before the dummy frame is popped. */
|
|
struct value *return_value = nullptr;
|
|
|
|
/* The top level that started the infcall (and is synchronously
|
|
waiting for it to end). */
|
|
struct ui *waiting_ui;
|
|
|
|
call_thread_fsm (struct ui *waiting_ui, struct interp *cmd_interp,
|
|
struct gdbarch *gdbarch, struct value *function,
|
|
struct type *value_type,
|
|
int struct_return_p, CORE_ADDR struct_addr);
|
|
|
|
bool should_stop (struct thread_info *thread) override;
|
|
|
|
bool should_notify_stop () override;
|
|
};
|
|
|
|
/* Allocate a new call_thread_fsm object. */
|
|
|
|
call_thread_fsm::call_thread_fsm (struct ui *waiting_ui,
|
|
struct interp *cmd_interp,
|
|
struct gdbarch *gdbarch,
|
|
struct value *function,
|
|
struct type *value_type,
|
|
int struct_return_p, CORE_ADDR struct_addr)
|
|
: thread_fsm (cmd_interp),
|
|
waiting_ui (waiting_ui)
|
|
{
|
|
return_meta_info.gdbarch = gdbarch;
|
|
return_meta_info.function = function;
|
|
return_meta_info.value_type = value_type;
|
|
return_meta_info.struct_return_p = struct_return_p;
|
|
return_meta_info.struct_addr = struct_addr;
|
|
}
|
|
|
|
/* Implementation of should_stop method for infcalls. */
|
|
|
|
bool
|
|
call_thread_fsm::should_stop (struct thread_info *thread)
|
|
{
|
|
if (stop_stack_dummy == STOP_STACK_DUMMY)
|
|
{
|
|
/* Done. */
|
|
set_finished ();
|
|
|
|
/* Stash the return value before the dummy frame is popped and
|
|
registers are restored to what they were before the
|
|
call.. */
|
|
return_value = get_call_return_value (&return_meta_info);
|
|
|
|
/* Break out of wait_sync_command_done. */
|
|
scoped_restore save_ui = make_scoped_restore (¤t_ui, waiting_ui);
|
|
target_terminal::ours ();
|
|
waiting_ui->prompt_state = PROMPT_NEEDED;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/* Implementation of should_notify_stop method for infcalls. */
|
|
|
|
bool
|
|
call_thread_fsm::should_notify_stop ()
|
|
{
|
|
if (finished_p ())
|
|
{
|
|
/* Infcall succeeded. Be silent and proceed with evaluating the
|
|
expression. */
|
|
return false;
|
|
}
|
|
|
|
/* Something wrong happened. E.g., an unexpected breakpoint
|
|
triggered, or a signal was intercepted. Notify the stop. */
|
|
return true;
|
|
}
|
|
|
|
/* Subroutine of call_function_by_hand to simplify it.
|
|
Start up the inferior and wait for it to stop.
|
|
Return the exception if there's an error, or an exception with
|
|
reason >= 0 if there's no error.
|
|
|
|
This is done inside a TRY_CATCH so the caller needn't worry about
|
|
thrown errors. The caller should rethrow if there's an error. */
|
|
|
|
static struct gdb_exception
|
|
run_inferior_call (struct call_thread_fsm *sm,
|
|
struct thread_info *call_thread, CORE_ADDR real_pc)
|
|
{
|
|
struct gdb_exception caught_error;
|
|
int saved_in_infcall = call_thread->control.in_infcall;
|
|
ptid_t call_thread_ptid = call_thread->ptid;
|
|
enum prompt_state saved_prompt_state = current_ui->prompt_state;
|
|
int was_running = call_thread->state == THREAD_RUNNING;
|
|
int saved_ui_async = current_ui->async;
|
|
|
|
/* Infcalls run synchronously, in the foreground. */
|
|
current_ui->prompt_state = PROMPT_BLOCKED;
|
|
/* So that we don't print the prompt prematurely in
|
|
fetch_inferior_event. */
|
|
current_ui->async = 0;
|
|
|
|
delete_file_handler (current_ui->input_fd);
|
|
|
|
call_thread->control.in_infcall = 1;
|
|
|
|
clear_proceed_status (0);
|
|
|
|
/* Associate the FSM with the thread after clear_proceed_status
|
|
(otherwise it'd clear this FSM), and before anything throws, so
|
|
we don't leak it (and any resources it manages). */
|
|
call_thread->thread_fsm = sm;
|
|
|
|
disable_watchpoints_before_interactive_call_start ();
|
|
|
|
/* We want to print return value, please... */
|
|
call_thread->control.proceed_to_finish = 1;
|
|
|
|
try
|
|
{
|
|
proceed (real_pc, GDB_SIGNAL_0);
|
|
|
|
/* Inferior function calls are always synchronous, even if the
|
|
target supports asynchronous execution. */
|
|
wait_sync_command_done ();
|
|
}
|
|
catch (gdb_exception &e)
|
|
{
|
|
caught_error = std::move (e);
|
|
}
|
|
|
|
/* If GDB has the prompt blocked before, then ensure that it remains
|
|
so. normal_stop calls async_enable_stdin, so reset the prompt
|
|
state again here. In other cases, stdin will be re-enabled by
|
|
inferior_event_handler, when an exception is thrown. */
|
|
current_ui->prompt_state = saved_prompt_state;
|
|
if (current_ui->prompt_state == PROMPT_BLOCKED)
|
|
delete_file_handler (current_ui->input_fd);
|
|
else
|
|
ui_register_input_event_handler (current_ui);
|
|
current_ui->async = saved_ui_async;
|
|
|
|
/* If the infcall does NOT succeed, normal_stop will have already
|
|
finished the thread states. However, on success, normal_stop
|
|
defers here, so that we can set back the thread states to what
|
|
they were before the call. Note that we must also finish the
|
|
state of new threads that might have spawned while the call was
|
|
running. The main cases to handle are:
|
|
|
|
- "(gdb) print foo ()", or any other command that evaluates an
|
|
expression at the prompt. (The thread was marked stopped before.)
|
|
|
|
- "(gdb) break foo if return_false()" or similar cases where we
|
|
do an infcall while handling an event (while the thread is still
|
|
marked running). In this example, whether the condition
|
|
evaluates true and thus we'll present a user-visible stop is
|
|
decided elsewhere. */
|
|
if (!was_running
|
|
&& call_thread_ptid == inferior_ptid
|
|
&& stop_stack_dummy == STOP_STACK_DUMMY)
|
|
finish_thread_state (call_thread->inf->process_target (),
|
|
user_visible_resume_ptid (0));
|
|
|
|
enable_watchpoints_after_interactive_call_stop ();
|
|
|
|
/* Call breakpoint_auto_delete on the current contents of the bpstat
|
|
of inferior call thread.
|
|
If all error()s out of proceed ended up calling normal_stop
|
|
(and perhaps they should; it already does in the special case
|
|
of error out of resume()), then we wouldn't need this. */
|
|
if (caught_error.reason < 0)
|
|
{
|
|
if (call_thread->state != THREAD_EXITED)
|
|
breakpoint_auto_delete (call_thread->control.stop_bpstat);
|
|
}
|
|
|
|
call_thread->control.in_infcall = saved_in_infcall;
|
|
|
|
return caught_error;
|
|
}
|
|
|
|
/* Reserve space on the stack for a value of the given type.
|
|
Return the address of the allocated space.
|
|
Make certain that the value is correctly aligned.
|
|
The SP argument is modified. */
|
|
|
|
static CORE_ADDR
|
|
reserve_stack_space (const type *values_type, CORE_ADDR &sp)
|
|
{
|
|
struct frame_info *frame = get_current_frame ();
|
|
struct gdbarch *gdbarch = get_frame_arch (frame);
|
|
CORE_ADDR addr = 0;
|
|
|
|
if (gdbarch_inner_than (gdbarch, 1, 2))
|
|
{
|
|
/* Stack grows downward. Align STRUCT_ADDR and SP after
|
|
making space. */
|
|
sp -= TYPE_LENGTH (values_type);
|
|
if (gdbarch_frame_align_p (gdbarch))
|
|
sp = gdbarch_frame_align (gdbarch, sp);
|
|
addr = sp;
|
|
}
|
|
else
|
|
{
|
|
/* Stack grows upward. Align the frame, allocate space, and
|
|
then again, re-align the frame??? */
|
|
if (gdbarch_frame_align_p (gdbarch))
|
|
sp = gdbarch_frame_align (gdbarch, sp);
|
|
addr = sp;
|
|
sp += TYPE_LENGTH (values_type);
|
|
if (gdbarch_frame_align_p (gdbarch))
|
|
sp = gdbarch_frame_align (gdbarch, sp);
|
|
}
|
|
|
|
return addr;
|
|
}
|
|
|
|
/* The data structure which keeps a destructor function and
|
|
its implicit 'this' parameter. */
|
|
|
|
struct destructor_info
|
|
{
|
|
destructor_info (struct value *function, struct value *self)
|
|
: function (function), self (self) { }
|
|
|
|
struct value *function;
|
|
struct value *self;
|
|
};
|
|
|
|
|
|
/* Auxiliary function that takes a list of destructor functions
|
|
with their 'this' parameters, and invokes the functions. */
|
|
|
|
static void
|
|
call_destructors (const std::list<destructor_info> &dtors_to_invoke,
|
|
struct type *default_return_type)
|
|
{
|
|
for (auto vals : dtors_to_invoke)
|
|
{
|
|
call_function_by_hand (vals.function, default_return_type,
|
|
gdb::make_array_view (&(vals.self), 1));
|
|
}
|
|
}
|
|
|
|
/* See infcall.h. */
|
|
|
|
struct value *
|
|
call_function_by_hand (struct value *function,
|
|
type *default_return_type,
|
|
gdb::array_view<value *> args)
|
|
{
|
|
return call_function_by_hand_dummy (function, default_return_type,
|
|
args, NULL, NULL);
|
|
}
|
|
|
|
/* All this stuff with a dummy frame may seem unnecessarily complicated
|
|
(why not just save registers in GDB?). The purpose of pushing a dummy
|
|
frame which looks just like a real frame is so that if you call a
|
|
function and then hit a breakpoint (get a signal, etc), "backtrace"
|
|
will look right. Whether the backtrace needs to actually show the
|
|
stack at the time the inferior function was called is debatable, but
|
|
it certainly needs to not display garbage. So if you are contemplating
|
|
making dummy frames be different from normal frames, consider that. */
|
|
|
|
/* Perform a function call in the inferior.
|
|
ARGS is a vector of values of arguments.
|
|
FUNCTION is a value, the function to be called.
|
|
Returns a value representing what the function returned.
|
|
May fail to return, if a breakpoint or signal is hit
|
|
during the execution of the function.
|
|
|
|
ARGS is modified to contain coerced values. */
|
|
|
|
struct value *
|
|
call_function_by_hand_dummy (struct value *function,
|
|
type *default_return_type,
|
|
gdb::array_view<value *> args,
|
|
dummy_frame_dtor_ftype *dummy_dtor,
|
|
void *dummy_dtor_data)
|
|
{
|
|
CORE_ADDR sp;
|
|
struct type *target_values_type;
|
|
function_call_return_method return_method = return_method_normal;
|
|
CORE_ADDR struct_addr = 0;
|
|
CORE_ADDR real_pc;
|
|
CORE_ADDR bp_addr;
|
|
struct frame_id dummy_id;
|
|
struct frame_info *frame;
|
|
struct gdbarch *gdbarch;
|
|
ptid_t call_thread_ptid;
|
|
struct gdb_exception e;
|
|
char name_buf[RAW_FUNCTION_ADDRESS_SIZE];
|
|
|
|
if (!may_call_functions_p)
|
|
error (_("Cannot call functions in the program: "
|
|
"may-call-functions is off."));
|
|
|
|
if (!target_has_execution)
|
|
noprocess ();
|
|
|
|
if (get_traceframe_number () >= 0)
|
|
error (_("May not call functions while looking at trace frames."));
|
|
|
|
if (execution_direction == EXEC_REVERSE)
|
|
error (_("Cannot call functions in reverse mode."));
|
|
|
|
/* We're going to run the target, and inspect the thread's state
|
|
afterwards. Hold a strong reference so that the pointer remains
|
|
valid even if the thread exits. */
|
|
thread_info_ref call_thread
|
|
= thread_info_ref::new_reference (inferior_thread ());
|
|
|
|
bool stack_temporaries = thread_stack_temporaries_enabled_p (call_thread.get ());
|
|
|
|
frame = get_current_frame ();
|
|
gdbarch = get_frame_arch (frame);
|
|
|
|
if (!gdbarch_push_dummy_call_p (gdbarch))
|
|
error (_("This target does not support function calls."));
|
|
|
|
/* Find the function type and do a sanity check. */
|
|
type *ftype;
|
|
type *values_type;
|
|
CORE_ADDR funaddr = find_function_addr (function, &values_type, &ftype);
|
|
|
|
if (values_type == NULL)
|
|
values_type = default_return_type;
|
|
if (values_type == NULL)
|
|
{
|
|
const char *name = get_function_name (funaddr,
|
|
name_buf, sizeof (name_buf));
|
|
error (_("'%s' has unknown return type; "
|
|
"cast the call to its declared return type"),
|
|
name);
|
|
}
|
|
|
|
values_type = check_typedef (values_type);
|
|
|
|
if (args.size () < TYPE_NFIELDS (ftype))
|
|
error (_("Too few arguments in function call."));
|
|
|
|
/* A holder for the inferior status.
|
|
This is only needed while we're preparing the inferior function call. */
|
|
infcall_control_state_up inf_status (save_infcall_control_state ());
|
|
|
|
/* Save the caller's registers and other state associated with the
|
|
inferior itself so that they can be restored once the
|
|
callee returns. To allow nested calls the registers are (further
|
|
down) pushed onto a dummy frame stack. This unique pointer
|
|
is released once the regcache has been pushed). */
|
|
infcall_suspend_state_up caller_state (save_infcall_suspend_state ());
|
|
|
|
/* Ensure that the initial SP is correctly aligned. */
|
|
{
|
|
CORE_ADDR old_sp = get_frame_sp (frame);
|
|
|
|
if (gdbarch_frame_align_p (gdbarch))
|
|
{
|
|
sp = gdbarch_frame_align (gdbarch, old_sp);
|
|
/* NOTE: cagney/2003-08-13: Skip the "red zone". For some
|
|
ABIs, a function can use memory beyond the inner most stack
|
|
address. AMD64 called that region the "red zone". Skip at
|
|
least the "red zone" size before allocating any space on
|
|
the stack. */
|
|
if (gdbarch_inner_than (gdbarch, 1, 2))
|
|
sp -= gdbarch_frame_red_zone_size (gdbarch);
|
|
else
|
|
sp += gdbarch_frame_red_zone_size (gdbarch);
|
|
/* Still aligned? */
|
|
gdb_assert (sp == gdbarch_frame_align (gdbarch, sp));
|
|
/* NOTE: cagney/2002-09-18:
|
|
|
|
On a RISC architecture, a void parameterless generic dummy
|
|
frame (i.e., no parameters, no result) typically does not
|
|
need to push anything the stack and hence can leave SP and
|
|
FP. Similarly, a frameless (possibly leaf) function does
|
|
not push anything on the stack and, hence, that too can
|
|
leave FP and SP unchanged. As a consequence, a sequence of
|
|
void parameterless generic dummy frame calls to frameless
|
|
functions will create a sequence of effectively identical
|
|
frames (SP, FP and TOS and PC the same). This, not
|
|
surprisingly, results in what appears to be a stack in an
|
|
infinite loop --- when GDB tries to find a generic dummy
|
|
frame on the internal dummy frame stack, it will always
|
|
find the first one.
|
|
|
|
To avoid this problem, the code below always grows the
|
|
stack. That way, two dummy frames can never be identical.
|
|
It does burn a few bytes of stack but that is a small price
|
|
to pay :-). */
|
|
if (sp == old_sp)
|
|
{
|
|
if (gdbarch_inner_than (gdbarch, 1, 2))
|
|
/* Stack grows down. */
|
|
sp = gdbarch_frame_align (gdbarch, old_sp - 1);
|
|
else
|
|
/* Stack grows up. */
|
|
sp = gdbarch_frame_align (gdbarch, old_sp + 1);
|
|
}
|
|
/* SP may have underflown address zero here from OLD_SP. Memory access
|
|
functions will probably fail in such case but that is a target's
|
|
problem. */
|
|
}
|
|
else
|
|
/* FIXME: cagney/2002-09-18: Hey, you loose!
|
|
|
|
Who knows how badly aligned the SP is!
|
|
|
|
If the generic dummy frame ends up empty (because nothing is
|
|
pushed) GDB won't be able to correctly perform back traces.
|
|
If a target is having trouble with backtraces, first thing to
|
|
do is add FRAME_ALIGN() to the architecture vector. If that
|
|
fails, try dummy_id().
|
|
|
|
If the ABI specifies a "Red Zone" (see the doco) the code
|
|
below will quietly trash it. */
|
|
sp = old_sp;
|
|
|
|
/* Skip over the stack temporaries that might have been generated during
|
|
the evaluation of an expression. */
|
|
if (stack_temporaries)
|
|
{
|
|
struct value *lastval;
|
|
|
|
lastval = get_last_thread_stack_temporary (call_thread.get ());
|
|
if (lastval != NULL)
|
|
{
|
|
CORE_ADDR lastval_addr = value_address (lastval);
|
|
|
|
if (gdbarch_inner_than (gdbarch, 1, 2))
|
|
{
|
|
gdb_assert (sp >= lastval_addr);
|
|
sp = lastval_addr;
|
|
}
|
|
else
|
|
{
|
|
gdb_assert (sp <= lastval_addr);
|
|
sp = lastval_addr + TYPE_LENGTH (value_type (lastval));
|
|
}
|
|
|
|
if (gdbarch_frame_align_p (gdbarch))
|
|
sp = gdbarch_frame_align (gdbarch, sp);
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Are we returning a value using a structure return? */
|
|
|
|
if (gdbarch_return_in_first_hidden_param_p (gdbarch, values_type))
|
|
{
|
|
return_method = return_method_hidden_param;
|
|
|
|
/* Tell the target specific argument pushing routine not to
|
|
expect a value. */
|
|
target_values_type = builtin_type (gdbarch)->builtin_void;
|
|
}
|
|
else
|
|
{
|
|
if (using_struct_return (gdbarch, function, values_type))
|
|
return_method = return_method_struct;
|
|
target_values_type = values_type;
|
|
}
|
|
|
|
gdb::observers::inferior_call_pre.notify (inferior_ptid, funaddr);
|
|
|
|
/* Determine the location of the breakpoint (and possibly other
|
|
stuff) that the called function will return to. The SPARC, for a
|
|
function returning a structure or union, needs to make space for
|
|
not just the breakpoint but also an extra word containing the
|
|
size (?) of the structure being passed. */
|
|
|
|
switch (gdbarch_call_dummy_location (gdbarch))
|
|
{
|
|
case ON_STACK:
|
|
{
|
|
const gdb_byte *bp_bytes;
|
|
CORE_ADDR bp_addr_as_address;
|
|
int bp_size;
|
|
|
|
/* Be careful BP_ADDR is in inferior PC encoding while
|
|
BP_ADDR_AS_ADDRESS is a plain memory address. */
|
|
|
|
sp = push_dummy_code (gdbarch, sp, funaddr, args,
|
|
target_values_type, &real_pc, &bp_addr,
|
|
get_current_regcache ());
|
|
|
|
/* Write a legitimate instruction at the point where the infcall
|
|
breakpoint is going to be inserted. While this instruction
|
|
is never going to be executed, a user investigating the
|
|
memory from GDB would see this instruction instead of random
|
|
uninitialized bytes. We chose the breakpoint instruction
|
|
as it may look as the most logical one to the user and also
|
|
valgrind 3.7.0 needs it for proper vgdb inferior calls.
|
|
|
|
If software breakpoints are unsupported for this target we
|
|
leave the user visible memory content uninitialized. */
|
|
|
|
bp_addr_as_address = bp_addr;
|
|
bp_bytes = gdbarch_breakpoint_from_pc (gdbarch, &bp_addr_as_address,
|
|
&bp_size);
|
|
if (bp_bytes != NULL)
|
|
write_memory (bp_addr_as_address, bp_bytes, bp_size);
|
|
}
|
|
break;
|
|
case AT_ENTRY_POINT:
|
|
{
|
|
CORE_ADDR dummy_addr;
|
|
|
|
real_pc = funaddr;
|
|
dummy_addr = entry_point_address ();
|
|
|
|
/* A call dummy always consists of just a single breakpoint, so
|
|
its address is the same as the address of the dummy.
|
|
|
|
The actual breakpoint is inserted separatly so there is no need to
|
|
write that out. */
|
|
bp_addr = dummy_addr;
|
|
break;
|
|
}
|
|
default:
|
|
internal_error (__FILE__, __LINE__, _("bad switch"));
|
|
}
|
|
|
|
/* Coerce the arguments and handle pass-by-reference.
|
|
We want to remember the destruction required for pass-by-ref values.
|
|
For these, store the dtor function and the 'this' argument
|
|
in DTORS_TO_INVOKE. */
|
|
std::list<destructor_info> dtors_to_invoke;
|
|
|
|
for (int i = args.size () - 1; i >= 0; i--)
|
|
{
|
|
int prototyped;
|
|
struct type *param_type;
|
|
|
|
/* FIXME drow/2002-05-31: Should just always mark methods as
|
|
prototyped. Can we respect TYPE_VARARGS? Probably not. */
|
|
if (TYPE_CODE (ftype) == TYPE_CODE_METHOD)
|
|
prototyped = 1;
|
|
if (TYPE_TARGET_TYPE (ftype) == NULL && TYPE_NFIELDS (ftype) == 0
|
|
&& default_return_type != NULL)
|
|
{
|
|
/* Calling a no-debug function with the return type
|
|
explicitly cast. Assume the function is prototyped,
|
|
with a prototype matching the types of the arguments.
|
|
E.g., with:
|
|
float mult (float v1, float v2) { return v1 * v2; }
|
|
This:
|
|
(gdb) p (float) mult (2.0f, 3.0f)
|
|
Is a simpler alternative to:
|
|
(gdb) p ((float (*) (float, float)) mult) (2.0f, 3.0f)
|
|
*/
|
|
prototyped = 1;
|
|
}
|
|
else if (i < TYPE_NFIELDS (ftype))
|
|
prototyped = TYPE_PROTOTYPED (ftype);
|
|
else
|
|
prototyped = 0;
|
|
|
|
if (i < TYPE_NFIELDS (ftype))
|
|
param_type = TYPE_FIELD_TYPE (ftype, i);
|
|
else
|
|
param_type = NULL;
|
|
|
|
value *original_arg = args[i];
|
|
args[i] = value_arg_coerce (gdbarch, args[i],
|
|
param_type, prototyped);
|
|
|
|
if (param_type == NULL)
|
|
continue;
|
|
|
|
auto info = language_pass_by_reference (param_type);
|
|
if (!info.copy_constructible)
|
|
error (_("expression cannot be evaluated because the type '%s' "
|
|
"is not copy constructible"), TYPE_NAME (param_type));
|
|
|
|
if (!info.destructible)
|
|
error (_("expression cannot be evaluated because the type '%s' "
|
|
"is not destructible"), TYPE_NAME (param_type));
|
|
|
|
if (info.trivially_copyable)
|
|
continue;
|
|
|
|
/* Make a copy of the argument on the stack. If the argument is
|
|
trivially copy ctor'able, copy bit by bit. Otherwise, call
|
|
the copy ctor to initialize the clone. */
|
|
CORE_ADDR addr = reserve_stack_space (param_type, sp);
|
|
value *clone
|
|
= value_from_contents_and_address (param_type, nullptr, addr);
|
|
push_thread_stack_temporary (call_thread.get (), clone);
|
|
value *clone_ptr
|
|
= value_from_pointer (lookup_pointer_type (param_type), addr);
|
|
|
|
if (info.trivially_copy_constructible)
|
|
{
|
|
int length = TYPE_LENGTH (param_type);
|
|
write_memory (addr, value_contents (args[i]), length);
|
|
}
|
|
else
|
|
{
|
|
value *copy_ctor;
|
|
value *cctor_args[2] = { clone_ptr, original_arg };
|
|
find_overload_match (gdb::make_array_view (cctor_args, 2),
|
|
TYPE_NAME (param_type), METHOD,
|
|
&clone_ptr, nullptr, ©_ctor, nullptr,
|
|
nullptr, 0, EVAL_NORMAL);
|
|
|
|
if (copy_ctor == nullptr)
|
|
error (_("expression cannot be evaluated because a copy "
|
|
"constructor for the type '%s' could not be found "
|
|
"(maybe inlined?)"), TYPE_NAME (param_type));
|
|
|
|
call_function_by_hand (copy_ctor, default_return_type,
|
|
gdb::make_array_view (cctor_args, 2));
|
|
}
|
|
|
|
/* If the argument has a destructor, remember it so that we
|
|
invoke it after the infcall is complete. */
|
|
if (!info.trivially_destructible)
|
|
{
|
|
/* Looking up the function via overload resolution does not
|
|
work because the compiler (in particular, gcc) adds an
|
|
artificial int parameter in some cases. So we look up
|
|
the function by using the "~" name. This should be OK
|
|
because there can be only one dtor definition. */
|
|
const char *dtor_name = nullptr;
|
|
for (int fieldnum = 0;
|
|
fieldnum < TYPE_NFN_FIELDS (param_type);
|
|
fieldnum++)
|
|
{
|
|
fn_field *fn
|
|
= TYPE_FN_FIELDLIST1 (param_type, fieldnum);
|
|
const char *field_name
|
|
= TYPE_FN_FIELDLIST_NAME (param_type, fieldnum);
|
|
|
|
if (field_name[0] == '~')
|
|
dtor_name = TYPE_FN_FIELD_PHYSNAME (fn, 0);
|
|
}
|
|
|
|
if (dtor_name == nullptr)
|
|
error (_("expression cannot be evaluated because a destructor "
|
|
"for the type '%s' could not be found "
|
|
"(maybe inlined?)"), TYPE_NAME (param_type));
|
|
|
|
value *dtor
|
|
= find_function_in_inferior (dtor_name, 0);
|
|
|
|
/* Insert the dtor to the front of the list to call them
|
|
in reverse order later. */
|
|
dtors_to_invoke.emplace_front (dtor, clone_ptr);
|
|
}
|
|
|
|
args[i] = clone_ptr;
|
|
}
|
|
|
|
/* Reserve space for the return structure to be written on the
|
|
stack, if necessary.
|
|
|
|
While evaluating expressions, we reserve space on the stack for
|
|
return values of class type even if the language ABI and the target
|
|
ABI do not require that the return value be passed as a hidden first
|
|
argument. This is because we want to store the return value as an
|
|
on-stack temporary while the expression is being evaluated. This
|
|
enables us to have chained function calls in expressions.
|
|
|
|
Keeping the return values as on-stack temporaries while the expression
|
|
is being evaluated is OK because the thread is stopped until the
|
|
expression is completely evaluated. */
|
|
|
|
if (return_method != return_method_normal
|
|
|| (stack_temporaries && class_or_union_p (values_type)))
|
|
struct_addr = reserve_stack_space (values_type, sp);
|
|
|
|
std::vector<struct value *> new_args;
|
|
if (return_method == return_method_hidden_param)
|
|
{
|
|
/* Add the new argument to the front of the argument list. */
|
|
new_args.reserve (args.size ());
|
|
new_args.push_back
|
|
(value_from_pointer (lookup_pointer_type (values_type), struct_addr));
|
|
new_args.insert (new_args.end (), args.begin (), args.end ());
|
|
args = new_args;
|
|
}
|
|
|
|
/* Create the dummy stack frame. Pass in the call dummy address as,
|
|
presumably, the ABI code knows where, in the call dummy, the
|
|
return address should be pointed. */
|
|
sp = gdbarch_push_dummy_call (gdbarch, function, get_current_regcache (),
|
|
bp_addr, args.size (), args.data (),
|
|
sp, return_method, struct_addr);
|
|
|
|
/* Set up a frame ID for the dummy frame so we can pass it to
|
|
set_momentary_breakpoint. We need to give the breakpoint a frame
|
|
ID so that the breakpoint code can correctly re-identify the
|
|
dummy breakpoint. */
|
|
/* Sanity. The exact same SP value is returned by PUSH_DUMMY_CALL,
|
|
saved as the dummy-frame TOS, and used by dummy_id to form
|
|
the frame ID's stack address. */
|
|
dummy_id = frame_id_build (sp, bp_addr);
|
|
|
|
/* Create a momentary breakpoint at the return address of the
|
|
inferior. That way it breaks when it returns. */
|
|
|
|
{
|
|
symtab_and_line sal;
|
|
sal.pspace = current_program_space;
|
|
sal.pc = bp_addr;
|
|
sal.section = find_pc_overlay (sal.pc);
|
|
|
|
/* Sanity. The exact same SP value is returned by
|
|
PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
|
|
dummy_id to form the frame ID's stack address. */
|
|
breakpoint *bpt
|
|
= set_momentary_breakpoint (gdbarch, sal,
|
|
dummy_id, bp_call_dummy).release ();
|
|
|
|
/* set_momentary_breakpoint invalidates FRAME. */
|
|
frame = NULL;
|
|
|
|
bpt->disposition = disp_del;
|
|
gdb_assert (bpt->related_breakpoint == bpt);
|
|
|
|
breakpoint *longjmp_b = set_longjmp_breakpoint_for_call_dummy ();
|
|
if (longjmp_b)
|
|
{
|
|
/* Link BPT into the chain of LONGJMP_B. */
|
|
bpt->related_breakpoint = longjmp_b;
|
|
while (longjmp_b->related_breakpoint != bpt->related_breakpoint)
|
|
longjmp_b = longjmp_b->related_breakpoint;
|
|
longjmp_b->related_breakpoint = bpt;
|
|
}
|
|
}
|
|
|
|
/* Create a breakpoint in std::terminate.
|
|
If a C++ exception is raised in the dummy-frame, and the
|
|
exception handler is (normally, and expected to be) out-of-frame,
|
|
the default C++ handler will (wrongly) be called in an inferior
|
|
function call. This is wrong, as an exception can be normally
|
|
and legally handled out-of-frame. The confines of the dummy frame
|
|
prevent the unwinder from finding the correct handler (or any
|
|
handler, unless it is in-frame). The default handler calls
|
|
std::terminate. This will kill the inferior. Assert that
|
|
terminate should never be called in an inferior function
|
|
call. Place a momentary breakpoint in the std::terminate function
|
|
and if triggered in the call, rewind. */
|
|
if (unwind_on_terminating_exception_p)
|
|
set_std_terminate_breakpoint ();
|
|
|
|
/* Everything's ready, push all the info needed to restore the
|
|
caller (and identify the dummy-frame) onto the dummy-frame
|
|
stack. */
|
|
dummy_frame_push (caller_state.release (), &dummy_id, call_thread.get ());
|
|
if (dummy_dtor != NULL)
|
|
register_dummy_frame_dtor (dummy_id, call_thread.get (),
|
|
dummy_dtor, dummy_dtor_data);
|
|
|
|
/* Register a clean-up for unwind_on_terminating_exception_breakpoint. */
|
|
SCOPE_EXIT { delete_std_terminate_breakpoint (); };
|
|
|
|
/* - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP -
|
|
If you're looking to implement asynchronous dummy-frames, then
|
|
just below is the place to chop this function in two.. */
|
|
|
|
{
|
|
struct thread_fsm *saved_sm;
|
|
struct call_thread_fsm *sm;
|
|
|
|
/* Save the current FSM. We'll override it. */
|
|
saved_sm = call_thread->thread_fsm;
|
|
call_thread->thread_fsm = NULL;
|
|
|
|
/* Save this thread's ptid, we need it later but the thread
|
|
may have exited. */
|
|
call_thread_ptid = call_thread->ptid;
|
|
|
|
/* Run the inferior until it stops. */
|
|
|
|
/* Create the FSM used to manage the infcall. It tells infrun to
|
|
not report the stop to the user, and captures the return value
|
|
before the dummy frame is popped. run_inferior_call registers
|
|
it with the thread ASAP. */
|
|
sm = new call_thread_fsm (current_ui, command_interp (),
|
|
gdbarch, function,
|
|
values_type,
|
|
return_method != return_method_normal,
|
|
struct_addr);
|
|
|
|
e = run_inferior_call (sm, call_thread.get (), real_pc);
|
|
|
|
gdb::observers::inferior_call_post.notify (call_thread_ptid, funaddr);
|
|
|
|
if (call_thread->state != THREAD_EXITED)
|
|
{
|
|
/* The FSM should still be the same. */
|
|
gdb_assert (call_thread->thread_fsm == sm);
|
|
|
|
if (call_thread->thread_fsm->finished_p ())
|
|
{
|
|
struct value *retval;
|
|
|
|
/* The inferior call is successful. Pop the dummy frame,
|
|
which runs its destructors and restores the inferior's
|
|
suspend state, and restore the inferior control
|
|
state. */
|
|
dummy_frame_pop (dummy_id, call_thread.get ());
|
|
restore_infcall_control_state (inf_status.release ());
|
|
|
|
/* Get the return value. */
|
|
retval = sm->return_value;
|
|
|
|
/* Clean up / destroy the call FSM, and restore the
|
|
original one. */
|
|
call_thread->thread_fsm->clean_up (call_thread.get ());
|
|
delete call_thread->thread_fsm;
|
|
call_thread->thread_fsm = saved_sm;
|
|
|
|
maybe_remove_breakpoints ();
|
|
|
|
gdb_assert (retval != NULL);
|
|
|
|
/* Destruct the pass-by-ref argument clones. */
|
|
call_destructors (dtors_to_invoke, default_return_type);
|
|
|
|
return retval;
|
|
}
|
|
|
|
/* Didn't complete. Clean up / destroy the call FSM, and restore the
|
|
previous state machine, and handle the error. */
|
|
call_thread->thread_fsm->clean_up (call_thread.get ());
|
|
delete call_thread->thread_fsm;
|
|
call_thread->thread_fsm = saved_sm;
|
|
}
|
|
}
|
|
|
|
/* Rethrow an error if we got one trying to run the inferior. */
|
|
|
|
if (e.reason < 0)
|
|
{
|
|
const char *name = get_function_name (funaddr,
|
|
name_buf, sizeof (name_buf));
|
|
|
|
discard_infcall_control_state (inf_status.release ());
|
|
|
|
/* We could discard the dummy frame here if the program exited,
|
|
but it will get garbage collected the next time the program is
|
|
run anyway. */
|
|
|
|
switch (e.reason)
|
|
{
|
|
case RETURN_ERROR:
|
|
throw_error (e.error, _("%s\n\
|
|
An error occurred while in a function called from GDB.\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned.\n\
|
|
When the function is done executing, GDB will silently stop."),
|
|
e.what (), name);
|
|
case RETURN_QUIT:
|
|
default:
|
|
throw_exception (std::move (e));
|
|
}
|
|
}
|
|
|
|
/* If the program has exited, or we stopped at a different thread,
|
|
exit and inform the user. */
|
|
|
|
if (! target_has_execution)
|
|
{
|
|
const char *name = get_function_name (funaddr,
|
|
name_buf, sizeof (name_buf));
|
|
|
|
/* If we try to restore the inferior status,
|
|
we'll crash as the inferior is no longer running. */
|
|
discard_infcall_control_state (inf_status.release ());
|
|
|
|
/* We could discard the dummy frame here given that the program exited,
|
|
but it will get garbage collected the next time the program is
|
|
run anyway. */
|
|
|
|
error (_("The program being debugged exited while in a function "
|
|
"called from GDB.\n"
|
|
"Evaluation of the expression containing the function\n"
|
|
"(%s) will be abandoned."),
|
|
name);
|
|
}
|
|
|
|
if (call_thread_ptid != inferior_ptid)
|
|
{
|
|
const char *name = get_function_name (funaddr,
|
|
name_buf, sizeof (name_buf));
|
|
|
|
/* We've switched threads. This can happen if another thread gets a
|
|
signal or breakpoint while our thread was running.
|
|
There's no point in restoring the inferior status,
|
|
we're in a different thread. */
|
|
discard_infcall_control_state (inf_status.release ());
|
|
/* Keep the dummy frame record, if the user switches back to the
|
|
thread with the hand-call, we'll need it. */
|
|
if (stopped_by_random_signal)
|
|
error (_("\
|
|
The program received a signal in another thread while\n\
|
|
making a function call from GDB.\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned.\n\
|
|
When the function is done executing, GDB will silently stop."),
|
|
name);
|
|
else
|
|
error (_("\
|
|
The program stopped in another thread while making a function call from GDB.\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned.\n\
|
|
When the function is done executing, GDB will silently stop."),
|
|
name);
|
|
}
|
|
|
|
{
|
|
/* Make a copy as NAME may be in an objfile freed by dummy_frame_pop. */
|
|
std::string name = get_function_name (funaddr, name_buf,
|
|
sizeof (name_buf));
|
|
|
|
if (stopped_by_random_signal)
|
|
{
|
|
/* We stopped inside the FUNCTION because of a random
|
|
signal. Further execution of the FUNCTION is not
|
|
allowed. */
|
|
|
|
if (unwind_on_signal_p)
|
|
{
|
|
/* The user wants the context restored. */
|
|
|
|
/* We must get back to the frame we were before the
|
|
dummy call. */
|
|
dummy_frame_pop (dummy_id, call_thread.get ());
|
|
|
|
/* We also need to restore inferior status to that before the
|
|
dummy call. */
|
|
restore_infcall_control_state (inf_status.release ());
|
|
|
|
/* FIXME: Insert a bunch of wrap_here; name can be very
|
|
long if it's a C++ name with arguments and stuff. */
|
|
error (_("\
|
|
The program being debugged was signaled while in a function called from GDB.\n\
|
|
GDB has restored the context to what it was before the call.\n\
|
|
To change this behavior use \"set unwindonsignal off\".\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned."),
|
|
name.c_str ());
|
|
}
|
|
else
|
|
{
|
|
/* The user wants to stay in the frame where we stopped
|
|
(default).
|
|
Discard inferior status, we're not at the same point
|
|
we started at. */
|
|
discard_infcall_control_state (inf_status.release ());
|
|
|
|
/* FIXME: Insert a bunch of wrap_here; name can be very
|
|
long if it's a C++ name with arguments and stuff. */
|
|
error (_("\
|
|
The program being debugged was signaled while in a function called from GDB.\n\
|
|
GDB remains in the frame where the signal was received.\n\
|
|
To change this behavior use \"set unwindonsignal on\".\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned.\n\
|
|
When the function is done executing, GDB will silently stop."),
|
|
name.c_str ());
|
|
}
|
|
}
|
|
|
|
if (stop_stack_dummy == STOP_STD_TERMINATE)
|
|
{
|
|
/* We must get back to the frame we were before the dummy
|
|
call. */
|
|
dummy_frame_pop (dummy_id, call_thread.get ());
|
|
|
|
/* We also need to restore inferior status to that before
|
|
the dummy call. */
|
|
restore_infcall_control_state (inf_status.release ());
|
|
|
|
error (_("\
|
|
The program being debugged entered a std::terminate call, most likely\n\
|
|
caused by an unhandled C++ exception. GDB blocked this call in order\n\
|
|
to prevent the program from being terminated, and has restored the\n\
|
|
context to its original state before the call.\n\
|
|
To change this behaviour use \"set unwind-on-terminating-exception off\".\n\
|
|
Evaluation of the expression containing the function (%s)\n\
|
|
will be abandoned."),
|
|
name.c_str ());
|
|
}
|
|
else if (stop_stack_dummy == STOP_NONE)
|
|
{
|
|
|
|
/* We hit a breakpoint inside the FUNCTION.
|
|
Keep the dummy frame, the user may want to examine its state.
|
|
Discard inferior status, we're not at the same point
|
|
we started at. */
|
|
discard_infcall_control_state (inf_status.release ());
|
|
|
|
/* The following error message used to say "The expression
|
|
which contained the function call has been discarded."
|
|
It is a hard concept to explain in a few words. Ideally,
|
|
GDB would be able to resume evaluation of the expression
|
|
when the function finally is done executing. Perhaps
|
|
someday this will be implemented (it would not be easy). */
|
|
/* FIXME: Insert a bunch of wrap_here; name can be very long if it's
|
|
a C++ name with arguments and stuff. */
|
|
error (_("\
|
|
The program being debugged stopped while in a function called from GDB.\n\
|
|
Evaluation of the expression containing the function\n\
|
|
(%s) will be abandoned.\n\
|
|
When the function is done executing, GDB will silently stop."),
|
|
name.c_str ());
|
|
}
|
|
|
|
}
|
|
|
|
/* The above code errors out, so ... */
|
|
gdb_assert_not_reached ("... should not be here");
|
|
}
|
|
|
|
void
|
|
_initialize_infcall (void)
|
|
{
|
|
add_setshow_boolean_cmd ("may-call-functions", no_class,
|
|
&may_call_functions_p, _("\
|
|
Set permission to call functions in the program."), _("\
|
|
Show permission to call functions in the program."), _("\
|
|
When this permission is on, GDB may call functions in the program.\n\
|
|
Otherwise, any sort of attempt to call a function in the program\n\
|
|
will result in an error."),
|
|
NULL,
|
|
show_may_call_functions_p,
|
|
&setlist, &showlist);
|
|
|
|
add_setshow_boolean_cmd ("coerce-float-to-double", class_obscure,
|
|
&coerce_float_to_double_p, _("\
|
|
Set coercion of floats to doubles when calling functions."), _("\
|
|
Show coercion of floats to doubles when calling functions."), _("\
|
|
Variables of type float should generally be converted to doubles before\n\
|
|
calling an unprototyped function, and left alone when calling a prototyped\n\
|
|
function. However, some older debug info formats do not provide enough\n\
|
|
information to determine that a function is prototyped. If this flag is\n\
|
|
set, GDB will perform the conversion for a function it considers\n\
|
|
unprototyped.\n\
|
|
The default is to perform the conversion."),
|
|
NULL,
|
|
show_coerce_float_to_double_p,
|
|
&setlist, &showlist);
|
|
|
|
add_setshow_boolean_cmd ("unwindonsignal", no_class,
|
|
&unwind_on_signal_p, _("\
|
|
Set unwinding of stack if a signal is received while in a call dummy."), _("\
|
|
Show unwinding of stack if a signal is received while in a call dummy."), _("\
|
|
The unwindonsignal lets the user determine what gdb should do if a signal\n\
|
|
is received while in a function called from gdb (call dummy). If set, gdb\n\
|
|
unwinds the stack and restore the context to what as it was before the call.\n\
|
|
The default is to stop in the frame where the signal was received."),
|
|
NULL,
|
|
show_unwind_on_signal_p,
|
|
&setlist, &showlist);
|
|
|
|
add_setshow_boolean_cmd ("unwind-on-terminating-exception", no_class,
|
|
&unwind_on_terminating_exception_p, _("\
|
|
Set unwinding of stack if std::terminate is called while in call dummy."), _("\
|
|
Show unwinding of stack if std::terminate() is called while in a call dummy."),
|
|
_("\
|
|
The unwind on terminating exception flag lets the user determine\n\
|
|
what gdb should do if a std::terminate() call is made from the\n\
|
|
default exception handler. If set, gdb unwinds the stack and restores\n\
|
|
the context to what it was before the call. If unset, gdb allows the\n\
|
|
std::terminate call to proceed.\n\
|
|
The default is to unwind the frame."),
|
|
NULL,
|
|
show_unwind_on_terminating_exception_p,
|
|
&setlist, &showlist);
|
|
|
|
}
|