xref: /netbsd-src/external/gpl3/gdb/dist/gdb/scoped-mock-context.h (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1 /* RAII type to create a temporary mock context.
2 
3    Copyright (C) 2020-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 #ifndef SCOPED_MOCK_CONTEXT_H
21 #define SCOPED_MOCK_CONTEXT_H
22 
23 #include "inferior.h"
24 #include "gdbthread.h"
25 #include "progspace.h"
26 #include "progspace-and-thread.h"
27 
28 #if GDB_SELF_TEST
29 namespace selftests {
30 
31 /* RAII type to create (and switch to) a temporary mock context.  An
32    inferior with a thread, with a process_stratum target pushed.  */
33 
34 template<typename Target>
35 struct scoped_mock_context
36 {
37   /* Order here is important.  */
38 
39   Target mock_target;
40   ptid_t mock_ptid {1, 1};
41   program_space mock_pspace {new address_space ()};
42   inferior mock_inferior {mock_ptid.pid ()};
43   thread_info mock_thread {&mock_inferior, mock_ptid};
44 
45   scoped_restore_current_pspace_and_thread restore_pspace_thread;
46 
47   explicit scoped_mock_context (gdbarch *gdbarch)
48   {
49     /* Add the mock inferior to the inferior list so that look ups by
50        target+ptid can find it.  */
51     inferior_list.push_back (mock_inferior);
52 
53     mock_inferior.thread_list.push_back (mock_thread);
54     mock_inferior.ptid_thread_map[mock_ptid] = &mock_thread;
55     mock_inferior.gdbarch = gdbarch;
56     mock_inferior.aspace = mock_pspace.aspace;
57     mock_inferior.pspace = &mock_pspace;
58 
59     /* Switch to the mock inferior.  */
60     switch_to_inferior_no_thread (&mock_inferior);
61 
62     /* Push the process_stratum target so we can mock accessing
63        registers.  */
64     gdb_assert (mock_target.stratum () == process_stratum);
65     mock_inferior.push_target (&mock_target);
66 
67     /* Switch to the mock thread.  */
68     switch_to_thread (&mock_thread);
69   }
70 
71   ~scoped_mock_context ()
72   {
73     inferior_list.erase (inferior_list.iterator_to (mock_inferior));
74     mock_inferior.pop_all_targets_at_and_above (process_stratum);
75   }
76 };
77 
78 } // namespace selftests
79 #endif /* GDB_SELF_TEST */
80 
81 #endif /* !defined (SCOPED_MOCK_CONTEXT_H) */
82