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