Wean gdb and sim off private libbfd.h header
[external/binutils.git] / sim / aarch64 / interp.c
1 /* interp.c -- AArch64 sim interface to GDB.
2
3    Copyright (C) 2015-2016 Free Software Foundation, Inc.
4
5    Contributed by Red Hat.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21
22 #include "config.h"
23 #include <stdio.h>
24 #include <assert.h>
25 #include <signal.h>
26 #include <string.h>
27 #include <ctype.h>
28 #include <stdlib.h>
29
30 #include "ansidecl.h"
31 #include "gdb/callback.h"
32 #include "gdb/remote-sim.h"
33 #include "gdb/signals.h"
34 #include "gdb/sim-aarch64.h"
35
36 #include "sim-main.h"
37 #include "sim-options.h"
38 #include "memory.h"
39 #include "simulator.h"
40
41 static unsigned long            symcount = 0;
42 static asymbol **               symtab = NULL;
43
44 /* Filter out (in place) symbols that are useless for disassembly.
45    COUNT is the number of elements in SYMBOLS.
46    Return the number of useful symbols. */
47
48 static unsigned long
49 remove_useless_symbols (asymbol **symbols, unsigned long count)
50 {
51   asymbol **in_ptr  = symbols;
52   asymbol **out_ptr = symbols;
53
54   while (count-- > 0)
55     {
56       asymbol *sym = *in_ptr++;
57
58       if (strstr (sym->name, "gcc2_compiled"))
59         continue;
60       if (sym->name == NULL || sym->name[0] == '\0')
61         continue;
62       if (sym->flags & (BSF_DEBUGGING))
63         continue;
64       if (   bfd_is_und_section (sym->section)
65           || bfd_is_com_section (sym->section))
66         continue;
67       if (sym->name[0] == '$')
68         continue;
69
70       *out_ptr++ = sym;
71     }
72   return out_ptr - symbols;
73 }
74
75 static signed int
76 compare_symbols (const void *ap, const void *bp)
77 {
78   const asymbol *a = * (const asymbol **) ap;
79   const asymbol *b = * (const asymbol **) bp;
80
81   if (bfd_asymbol_value (a) > bfd_asymbol_value (b))
82     return 1;
83   if (bfd_asymbol_value (a) < bfd_asymbol_value (b))
84     return -1;
85   return 0;
86 }
87
88 /* Find the name of the function at ADDR.  */
89 const char *
90 aarch64_get_func (uint64_t addr)
91 {
92   int  min, max;
93
94   min = -1;
95   max = symcount;
96   while (min < max - 1)
97     {
98       int sym;
99       bfd_vma sa;
100
101       sym = (min + max) / 2;
102       sa = bfd_asymbol_value (symtab[sym]);
103
104       if (sa > addr)
105         max = sym;
106       else if (sa < addr)
107         min = sym;
108       else
109         {
110           min = sym;
111           break;
112         }
113     }
114
115   if (min != -1)
116     return bfd_asymbol_name (symtab [min]);
117
118   return "";
119 }
120
121 uint64_t
122 aarch64_get_sym_value (const char *name)
123 {
124   unsigned long i;
125
126   for (i = 0; i < symcount; i++)
127     if (strcmp (bfd_asymbol_name (symtab[i]), name) == 0)
128       return bfd_asymbol_value (symtab[i]);
129
130   return 0;
131 }
132
133 SIM_RC
134 sim_create_inferior (SIM_DESC sd, struct bfd *abfd,
135                      char * const *argv, char * const *env)
136 {
137   sim_cpu *cpu = STATE_CPU (sd, 0);
138   long storage;
139   bfd_vma addr = 0;
140
141   if (abfd != NULL)
142     addr = bfd_get_start_address (abfd);
143
144   aarch64_set_next_PC (cpu, addr);
145   aarch64_update_PC (cpu);
146
147   /* Standalone mode (i.e. `run`) will take care of the argv for us in
148      sim_open() -> sim_parse_args().  But in debug mode (i.e. 'target sim'
149      with `gdb`), we need to handle it because the user can change the
150      argv on the fly via gdb's 'run'.  */
151   if (STATE_PROG_ARGV (sd) != argv)
152     {
153       freeargv (STATE_PROG_ARGV (sd));
154       STATE_PROG_ARGV (sd) = dupargv (argv);
155     }
156
157   storage = bfd_get_symtab_upper_bound (abfd);
158   if (storage > 0)
159     {
160       symtab = (asymbol **) xmalloc (storage);
161       symcount = bfd_canonicalize_symtab (abfd, symtab);
162       symcount = remove_useless_symbols (symtab, symcount);
163       qsort (symtab, symcount, sizeof (asymbol *), compare_symbols);
164     }
165
166   aarch64_init (cpu, bfd_get_start_address (abfd));
167
168   return SIM_RC_OK;
169 }
170
171 /* Read the LENGTH bytes at BUF as a little-endian value.  */
172
173 static bfd_vma
174 get_le (unsigned char *buf, unsigned int length)
175 {
176   bfd_vma acc = 0;
177
178   while (length -- > 0)
179     acc = (acc << 8) + buf[length];
180
181   return acc;
182 }
183
184 /* Store VAL as a little-endian value in the LENGTH bytes at BUF.  */
185
186 static void
187 put_le (unsigned char *buf, unsigned int length, bfd_vma val)
188 {
189   int i;
190
191   for (i = 0; i < length; i++)
192     {
193       buf[i] = val & 0xff;
194       val >>= 8;
195     }
196 }
197
198 static int
199 check_regno (int regno)
200 {
201   return 0 <= regno && regno < AARCH64_MAX_REGNO;
202 }
203
204 static size_t
205 reg_size (int regno)
206 {
207   if (regno == AARCH64_CPSR_REGNO || regno == AARCH64_FPSR_REGNO)
208     return 32;
209   return 64;
210 }
211
212 static int
213 aarch64_reg_get (SIM_CPU *cpu, int regno, unsigned char *buf, int length)
214 {
215   size_t size;
216   bfd_vma val;
217
218   if (!check_regno (regno))
219     return 0;
220
221   size = reg_size (regno);
222
223   if (length != size)
224     return 0;
225
226   switch (regno)
227     {
228     case AARCH64_MIN_GR ... AARCH64_MAX_GR:
229       val = aarch64_get_reg_u64 (cpu, regno, 0);
230       break;
231
232     case AARCH64_MIN_FR ... AARCH64_MAX_FR:
233       val = aarch64_get_FP_double (cpu, regno - 32);
234       break;
235
236     case AARCH64_PC_REGNO:
237       val = aarch64_get_PC (cpu);
238       break;
239
240     case AARCH64_CPSR_REGNO:
241       val = aarch64_get_CPSR (cpu);
242       break;
243
244     case AARCH64_FPSR_REGNO:
245       val = aarch64_get_FPSR (cpu);
246       break;
247
248     default:
249       sim_io_eprintf (CPU_STATE (cpu),
250                       "sim: unrecognized register number: %d\n", regno);
251       return -1;
252     }
253
254   put_le (buf, length, val);
255
256   return size;
257 }
258
259 static int
260 aarch64_reg_set (SIM_CPU *cpu, int regno, unsigned char *buf, int length)
261 {
262   size_t size;
263   bfd_vma val;
264
265   if (!check_regno (regno))
266     return -1;
267
268   size = reg_size (regno);
269
270   if (length != size)
271     return -1;
272
273   val = get_le (buf, length);
274
275   switch (regno)
276     {
277     case AARCH64_MIN_GR ... AARCH64_MAX_GR:
278       aarch64_set_reg_u64 (cpu, regno, 1, val);
279       break;
280
281     case AARCH64_MIN_FR ... AARCH64_MAX_FR:
282       aarch64_set_FP_double (cpu, regno - 32, (double) val);
283       break;
284
285     case AARCH64_PC_REGNO:
286       aarch64_set_next_PC (cpu, val);
287       aarch64_update_PC (cpu);
288       break;
289
290     case AARCH64_CPSR_REGNO:
291       aarch64_set_CPSR (cpu, val);
292       break;
293
294     case AARCH64_FPSR_REGNO:
295       aarch64_set_FPSR (cpu, val);
296       break;
297
298     default:
299       sim_io_eprintf (CPU_STATE (cpu),
300                       "sim: unrecognized register number: %d\n", regno);
301       return 0;
302     }
303
304   return size;
305 }
306
307 static sim_cia
308 aarch64_pc_get (sim_cpu *cpu)
309 {
310   return aarch64_get_PC (cpu);
311 }
312
313 static void
314 aarch64_pc_set (sim_cpu *cpu, sim_cia pc)
315 {
316   aarch64_set_next_PC (cpu, pc);
317   aarch64_update_PC (cpu);
318 }
319
320 static void
321 free_state (SIM_DESC sd)
322 {
323   if (STATE_MODULES (sd) != NULL)
324     sim_module_uninstall (sd);
325   sim_cpu_free_all (sd);
326   sim_state_free (sd);
327 }
328
329 SIM_DESC
330 sim_open (SIM_OPEN_KIND                  kind,
331           struct host_callback_struct *  callback,
332           struct bfd *                   abfd,
333           char * const *                 argv)
334 {
335   int i;
336   sim_cpu *cpu;
337   SIM_DESC sd = sim_state_alloc (kind, callback);
338
339   if (sd == NULL)
340     return sd;
341
342   SIM_ASSERT (STATE_MAGIC (sd) == SIM_MAGIC_NUMBER);
343
344   /* Perform the initialization steps one by one.  */
345   if (sim_cpu_alloc_all (sd, 1, 0) != SIM_RC_OK
346       || sim_pre_argv_init (sd, argv[0]) != SIM_RC_OK
347       || sim_parse_args (sd, argv) != SIM_RC_OK
348       || sim_analyze_program (sd,
349                               (STATE_PROG_ARGV (sd) != NULL
350                                ? *STATE_PROG_ARGV (sd)
351                                : NULL), abfd) != SIM_RC_OK
352       || sim_config (sd) != SIM_RC_OK
353       || sim_post_argv_init (sd) != SIM_RC_OK)
354     {
355       free_state (sd);
356       return NULL;
357     }
358
359   aarch64_init_LIT_table ();
360
361   assert (MAX_NR_PROCESSORS == 1);
362   cpu = STATE_CPU (sd, 0);
363   CPU_PC_FETCH (cpu) = aarch64_pc_get;
364   CPU_PC_STORE (cpu) = aarch64_pc_set;
365   CPU_REG_FETCH (cpu) = aarch64_reg_get;
366   CPU_REG_STORE (cpu) = aarch64_reg_set;
367
368   /* Set SP, FP and PC to 0 and set LR to -1
369      so we can detect a top-level return.  */
370   aarch64_set_reg_u64 (cpu, SP, 1, 0);
371   aarch64_set_reg_u64 (cpu, FP, 1, 0);
372   aarch64_set_reg_u64 (cpu, LR, 1, TOP_LEVEL_RETURN_PC);
373   aarch64_set_next_PC (cpu, 0);
374   aarch64_update_PC (cpu);
375
376   /* Default to a 128 Mbyte (== 2^27) memory space.  */
377   sim_do_commandf (sd, "memory-size 0x8000000");
378
379   return sd;
380 }
381
382 void
383 sim_engine_run (SIM_DESC sd,
384                 int next_cpu_nr ATTRIBUTE_UNUSED,
385                 int nr_cpus ATTRIBUTE_UNUSED,
386                 int siggnal ATTRIBUTE_UNUSED)
387 {
388   aarch64_run (sd);
389 }