Move locator code to tui-stack.c
[external/binutils.git] / gdb / gdbarch-selftests.c
1 /* Self tests for gdbarch for GDB, the GNU debugger.
2
3    Copyright (C) 2017-2019 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 #if GDB_SELF_TEST
22 #include "gdbsupport/selftest.h"
23 #include "selftest-arch.h"
24 #include "inferior.h"
25 #include "gdbthread.h"
26 #include "target.h"
27 #include "test-target.h"
28 #include "target-float.h"
29 #include "gdbsupport/def-vector.h"
30 #include "gdbarch.h"
31
32 namespace selftests {
33
34 /* Test gdbarch methods register_to_value and value_to_register.  */
35
36 static void
37 register_to_value_test (struct gdbarch *gdbarch)
38 {
39   const struct builtin_type *builtin = builtin_type (gdbarch);
40   struct type *types[] =
41     {
42       builtin->builtin_void,
43       builtin->builtin_char,
44       builtin->builtin_short,
45       builtin->builtin_int,
46       builtin->builtin_long,
47       builtin->builtin_signed_char,
48       builtin->builtin_unsigned_short,
49       builtin->builtin_unsigned_int,
50       builtin->builtin_unsigned_long,
51       builtin->builtin_float,
52       builtin->builtin_double,
53       builtin->builtin_long_double,
54       builtin->builtin_complex,
55       builtin->builtin_double_complex,
56       builtin->builtin_string,
57       builtin->builtin_bool,
58       builtin->builtin_long_long,
59       builtin->builtin_unsigned_long_long,
60       builtin->builtin_int8,
61       builtin->builtin_uint8,
62       builtin->builtin_int16,
63       builtin->builtin_uint16,
64       builtin->builtin_int32,
65       builtin->builtin_uint32,
66       builtin->builtin_int64,
67       builtin->builtin_uint64,
68       builtin->builtin_int128,
69       builtin->builtin_uint128,
70       builtin->builtin_char16,
71       builtin->builtin_char32,
72     };
73
74   /* Error out if debugging something, because we're going to push the
75      test target, which would pop any existing target.  */
76   if (current_top_target ()->stratum () >= process_stratum)
77    error (_("target already pushed"));
78
79   /* Create a mock environment.  An inferior with a thread, with a
80      process_stratum target pushed.  */
81
82   test_target_ops mock_target;
83   ptid_t mock_ptid (1, 1);
84   inferior mock_inferior (mock_ptid.pid ());
85   address_space mock_aspace {};
86   mock_inferior.gdbarch = gdbarch;
87   mock_inferior.aspace = &mock_aspace;
88   thread_info mock_thread (&mock_inferior, mock_ptid);
89
90   scoped_restore restore_thread_list
91     = make_scoped_restore (&mock_inferior.thread_list, &mock_thread);
92
93   /* Add the mock inferior to the inferior list so that look ups by
94      target+ptid can find it.  */
95   scoped_restore restore_inferior_list
96     = make_scoped_restore (&inferior_list);
97   inferior_list = &mock_inferior;
98
99   /* Switch to the mock inferior.  */
100   scoped_restore_current_inferior restore_current_inferior;
101   set_current_inferior (&mock_inferior);
102
103   /* Push the process_stratum target so we can mock accessing
104      registers.  */
105   push_target (&mock_target);
106
107   /* Pop it again on exit (return/exception).  */
108   SCOPE_EXIT { pop_all_targets_at_and_above (process_stratum); };
109
110   /* Switch to the mock thread.  */
111   scoped_restore restore_inferior_ptid
112     = make_scoped_restore (&inferior_ptid, mock_ptid);
113
114   struct frame_info *frame = get_current_frame ();
115   const int num_regs = gdbarch_num_cooked_regs (gdbarch);
116
117   /* Test gdbarch methods register_to_value and value_to_register with
118      different combinations of register numbers and types.  */
119   for (const auto &type : types)
120     {
121       for (auto regnum = 0; regnum < num_regs; regnum++)
122         {
123           if (gdbarch_convert_register_p (gdbarch, regnum, type))
124             {
125               std::vector<gdb_byte> expected (TYPE_LENGTH (type), 0);
126
127               if (TYPE_CODE (type) == TYPE_CODE_FLT)
128                 {
129                   /* Generate valid float format.  */
130                   target_float_from_string (expected.data (), type, "1.25");
131                 }
132               else
133                 {
134                   for (auto j = 0; j < expected.size (); j++)
135                     expected[j] = (regnum + j) % 16;
136                 }
137
138               gdbarch_value_to_register (gdbarch, frame, regnum, type,
139                                          expected.data ());
140
141               /* Allocate two bytes more for overflow check.  */
142               std::vector<gdb_byte> buf (TYPE_LENGTH (type) + 2, 0);
143               int optim, unavail, ok;
144
145               /* Set the fingerprint in the last two bytes.  */
146               buf [TYPE_LENGTH (type)]= 'w';
147               buf [TYPE_LENGTH (type) + 1]= 'l';
148               ok = gdbarch_register_to_value (gdbarch, frame, regnum, type,
149                                               buf.data (), &optim, &unavail);
150
151               SELF_CHECK (ok);
152               SELF_CHECK (!optim);
153               SELF_CHECK (!unavail);
154
155               SELF_CHECK (buf[TYPE_LENGTH (type)] == 'w');
156               SELF_CHECK (buf[TYPE_LENGTH (type) + 1] == 'l');
157
158               for (auto k = 0; k < TYPE_LENGTH(type); k++)
159                 SELF_CHECK (buf[k] == expected[k]);
160             }
161         }
162     }
163 }
164
165 } // namespace selftests
166 #endif /* GDB_SELF_TEST */
167
168 void
169 _initialize_gdbarch_selftests (void)
170 {
171 #if GDB_SELF_TEST
172   selftests::register_test_foreach_arch ("register_to_value",
173                                          selftests::register_to_value_test);
174 #endif
175 }