gdb: xtensa-linux: support THREADPTR register
[external/binutils.git] / gdb / xtensa-linux-nat.c
1 /* Xtensa GNU/Linux native support.
2
3    Copyright (C) 2007-2017 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 #include "frame.h"
22 #include "inferior.h"
23 #include "gdbcore.h"
24 #include "regcache.h"
25 #include "target.h"
26 #include "linux-nat.h"
27 #include <sys/types.h>
28 #include <signal.h>
29 #include <sys/user.h>
30 #include <sys/ioctl.h>
31 #include "gdb_wait.h"
32 #include <fcntl.h>
33 #include <sys/procfs.h>
34 #include "nat/gdb_ptrace.h"
35 #include <asm/ptrace.h>
36
37 #include "gregset.h"
38 #include "xtensa-tdep.h"
39
40 /* Defines ps_err_e, struct ps_prochandle.  */
41 #include "gdb_proc_service.h"
42
43 /* Extended register set depends on hardware configs.
44    Keeping these definitions separately allows to introduce
45    hardware-specific overlays.  */
46 #include "xtensa-xtregs.c"
47
48 void
49 fill_gregset (const struct regcache *regcache,
50               gdb_gregset_t *gregsetp, int regnum)
51 {
52   int i;
53   xtensa_elf_gregset_t *regs = (xtensa_elf_gregset_t *) gregsetp;
54   struct gdbarch *gdbarch = get_regcache_arch (regcache);
55
56   if (regnum == gdbarch_pc_regnum (gdbarch) || regnum == -1)
57     regcache_raw_collect (regcache, gdbarch_pc_regnum (gdbarch), &regs->pc);
58   if (regnum == gdbarch_ps_regnum (gdbarch) || regnum == -1)
59     regcache_raw_collect (regcache, gdbarch_ps_regnum (gdbarch), &regs->ps);
60
61   if (regnum == gdbarch_tdep (gdbarch)->wb_regnum || regnum == -1)
62     regcache_raw_collect (regcache,
63                           gdbarch_tdep (gdbarch)->wb_regnum,
64                           &regs->windowbase);
65   if (regnum == gdbarch_tdep (gdbarch)->ws_regnum || regnum == -1)
66     regcache_raw_collect (regcache,
67                           gdbarch_tdep (gdbarch)->ws_regnum,
68                           &regs->windowstart);
69   if (regnum == gdbarch_tdep (gdbarch)->lbeg_regnum || regnum == -1)
70     regcache_raw_collect (regcache,
71                           gdbarch_tdep (gdbarch)->lbeg_regnum,
72                           &regs->lbeg);
73   if (regnum == gdbarch_tdep (gdbarch)->lend_regnum || regnum == -1)
74     regcache_raw_collect (regcache,
75                           gdbarch_tdep (gdbarch)->lend_regnum,
76                           &regs->lend);
77   if (regnum == gdbarch_tdep (gdbarch)->lcount_regnum || regnum == -1)
78     regcache_raw_collect (regcache,
79                           gdbarch_tdep (gdbarch)->lcount_regnum,
80                           &regs->lcount);
81   if (regnum == gdbarch_tdep (gdbarch)->sar_regnum || regnum == -1)
82     regcache_raw_collect (regcache,
83                           gdbarch_tdep (gdbarch)->sar_regnum,
84                           &regs->sar);
85   if (regnum == gdbarch_tdep (gdbarch)->threadptr_regnum || regnum == -1)
86     regcache_raw_collect (regcache,
87                           gdbarch_tdep (gdbarch)->threadptr_regnum,
88                           &regs->threadptr);
89   if (regnum >=gdbarch_tdep (gdbarch)->ar_base
90       && regnum < gdbarch_tdep (gdbarch)->ar_base
91                     + gdbarch_tdep (gdbarch)->num_aregs)
92     regcache_raw_collect (regcache,regnum,
93                           &regs->ar[regnum - gdbarch_tdep (gdbarch)->ar_base]);
94   else if (regnum == -1)
95     {
96       for (i = 0; i < gdbarch_tdep (gdbarch)->num_aregs; ++i)
97         regcache_raw_collect (regcache,
98                               gdbarch_tdep (gdbarch)->ar_base + i,
99                               &regs->ar[i]);
100     }
101   if (regnum >= gdbarch_tdep (gdbarch)->a0_base
102       && regnum < gdbarch_tdep (gdbarch)->a0_base + C0_NREGS)
103     regcache_raw_collect (regcache, regnum,
104                           &regs->ar[(4 * regs->windowbase + regnum
105                                      - gdbarch_tdep (gdbarch)->a0_base)
106                           % gdbarch_tdep (gdbarch)->num_aregs]);
107   else if (regnum == -1)
108     {
109       for (i = 0; i < C0_NREGS; ++i)
110         regcache_raw_collect (regcache,
111                               gdbarch_tdep (gdbarch)->a0_base + i,
112                               &regs->ar[(4 * regs->windowbase + i)
113                               % gdbarch_tdep (gdbarch)->num_aregs]);
114     }
115 }
116
117 static void
118 supply_gregset_reg (struct regcache *regcache,
119                     const gdb_gregset_t *gregsetp, int regnum)
120 {
121   int i;
122   xtensa_elf_gregset_t *regs = (xtensa_elf_gregset_t *) gregsetp;
123
124   struct gdbarch *gdbarch = get_regcache_arch (regcache);
125
126   if (regnum == gdbarch_pc_regnum (gdbarch) || regnum == -1)
127     regcache_raw_supply (regcache, gdbarch_pc_regnum (gdbarch), &regs->pc);
128   if (regnum == gdbarch_ps_regnum (gdbarch) || regnum == -1)
129     regcache_raw_supply (regcache, gdbarch_ps_regnum (gdbarch), &regs->ps);
130
131   if (regnum == gdbarch_tdep (gdbarch)->wb_regnum || regnum == -1)
132     regcache_raw_supply (regcache,
133                           gdbarch_tdep (gdbarch)->wb_regnum,
134                           &regs->windowbase);
135   if (regnum == gdbarch_tdep (gdbarch)->ws_regnum || regnum == -1)
136     regcache_raw_supply (regcache,
137                           gdbarch_tdep (gdbarch)->ws_regnum,
138                           &regs->windowstart);
139   if (regnum == gdbarch_tdep (gdbarch)->lbeg_regnum || regnum == -1)
140     regcache_raw_supply (regcache,
141                           gdbarch_tdep (gdbarch)->lbeg_regnum,
142                           &regs->lbeg);
143   if (regnum == gdbarch_tdep (gdbarch)->lend_regnum || regnum == -1)
144     regcache_raw_supply (regcache,
145                           gdbarch_tdep (gdbarch)->lend_regnum,
146                           &regs->lend);
147   if (regnum == gdbarch_tdep (gdbarch)->lcount_regnum || regnum == -1)
148     regcache_raw_supply (regcache,
149                           gdbarch_tdep (gdbarch)->lcount_regnum,
150                           &regs->lcount);
151   if (regnum == gdbarch_tdep (gdbarch)->sar_regnum || regnum == -1)
152     regcache_raw_supply (regcache,
153                           gdbarch_tdep (gdbarch)->sar_regnum,
154                           &regs->sar);
155   if (regnum == gdbarch_tdep (gdbarch)->threadptr_regnum || regnum == -1)
156     regcache_raw_supply (regcache,
157                           gdbarch_tdep (gdbarch)->threadptr_regnum,
158                           &regs->threadptr);
159   if (regnum >=gdbarch_tdep (gdbarch)->ar_base
160       && regnum < gdbarch_tdep (gdbarch)->ar_base
161                     + gdbarch_tdep (gdbarch)->num_aregs)
162     regcache_raw_supply (regcache,regnum,
163                           &regs->ar[regnum - gdbarch_tdep (gdbarch)->ar_base]);
164   else if (regnum == -1)
165     {
166       for (i = 0; i < gdbarch_tdep (gdbarch)->num_aregs; ++i)
167         regcache_raw_supply (regcache,
168                               gdbarch_tdep (gdbarch)->ar_base + i,
169                               &regs->ar[i]);
170     }
171   if (regnum >= gdbarch_tdep (gdbarch)->a0_base
172       && regnum < gdbarch_tdep (gdbarch)->a0_base + C0_NREGS)
173     regcache_raw_supply (regcache, regnum,
174                          &regs->ar[(4 * regs->windowbase + regnum
175                                     - gdbarch_tdep (gdbarch)->a0_base)
176                          % gdbarch_tdep (gdbarch)->num_aregs]);
177   else if (regnum == -1)
178     {
179       for (i = 0; i < C0_NREGS; ++i)
180         regcache_raw_supply (regcache,
181                              gdbarch_tdep (gdbarch)->a0_base + i,
182                              &regs->ar[(4 * regs->windowbase + i)
183                              % gdbarch_tdep (gdbarch)->num_aregs]);
184     }
185 }
186
187 void
188 supply_gregset (struct regcache *regcache, const gdb_gregset_t *gregsetp)
189 {
190   supply_gregset_reg (regcache, gregsetp, -1);
191 }
192
193 void
194 fill_fpregset (const struct regcache *regcache,
195                gdb_fpregset_t *fpregsetp, int regnum)
196 {
197   return;
198 }
199
200 void 
201 supply_fpregset (struct regcache *regcache,
202                  const gdb_fpregset_t *fpregsetp)
203 {
204   return;
205 }
206
207 /* Fetch greg-register(s) from process/thread TID
208    and store value(s) in GDB's register array.  */
209
210 static void
211 fetch_gregs (struct regcache *regcache, int regnum)
212 {
213   int tid = ptid_get_lwp (regcache_get_ptid (regcache));
214   gdb_gregset_t regs;
215   int areg;
216   
217   if (ptrace (PTRACE_GETREGS, tid, 0, (long) &regs) < 0)
218     {
219       perror_with_name (_("Couldn't get registers"));
220       return;
221     }
222  
223   supply_gregset_reg (regcache, &regs, regnum);
224 }
225
226 /* Store greg-register(s) in GDB's register 
227    array into the process/thread specified by TID.  */
228
229 static void
230 store_gregs (struct regcache *regcache, int regnum)
231 {
232   int tid = ptid_get_lwp (regcache_get_ptid (regcache));
233   gdb_gregset_t regs;
234   int areg;
235
236   if (ptrace (PTRACE_GETREGS, tid, 0, (long) &regs) < 0)
237     {
238       perror_with_name (_("Couldn't get registers"));
239       return;
240     }
241
242   fill_gregset (regcache, &regs, regnum);
243
244   if (ptrace (PTRACE_SETREGS, tid, 0, (long) &regs) < 0)
245     {
246       perror_with_name (_("Couldn't write registers"));
247       return;
248     }
249 }
250
251 static int xtreg_lo;
252 static int xtreg_high;
253
254 /* Fetch/Store Xtensa TIE registers.  Xtensa GNU/Linux PTRACE
255    interface provides special requests for this.  */
256
257 static void
258 fetch_xtregs (struct regcache *regcache, int regnum)
259 {
260   int tid = ptid_get_lwp (regcache_get_ptid (regcache));
261   const xtensa_regtable_t *ptr;
262   char xtregs [XTENSA_ELF_XTREG_SIZE];
263
264   if (ptrace (PTRACE_GETXTREGS, tid, 0, (long)&xtregs) < 0)
265     perror_with_name (_("Couldn't get extended registers"));
266
267   for (ptr = xtensa_regmap_table; ptr->name; ptr++)
268     if (regnum == ptr->gdb_regnum || regnum == -1)
269       regcache_raw_supply (regcache, ptr->gdb_regnum,
270                            xtregs + ptr->ptrace_offset);
271 }
272
273 static void
274 store_xtregs (struct regcache *regcache, int regnum)
275 {
276   int tid = ptid_get_lwp (regcache_get_ptid (regcache));
277   const xtensa_regtable_t *ptr;
278   char xtregs [XTENSA_ELF_XTREG_SIZE];
279
280   if (ptrace (PTRACE_GETXTREGS, tid, 0, (long)&xtregs) < 0)
281     perror_with_name (_("Couldn't get extended registers"));
282
283   for (ptr = xtensa_regmap_table; ptr->name; ptr++)
284     if (regnum == ptr->gdb_regnum || regnum == -1)
285       regcache_raw_collect (regcache, ptr->gdb_regnum,
286                             xtregs + ptr->ptrace_offset);
287
288   if (ptrace (PTRACE_SETXTREGS, tid, 0, (long)&xtregs) < 0)
289     perror_with_name (_("Couldn't write extended registers"));
290 }
291
292 static void
293 xtensa_linux_fetch_inferior_registers (struct target_ops *ops,
294                                        struct regcache *regcache, int regnum)
295 {
296   if (regnum == -1)
297     {
298       fetch_gregs (regcache, regnum);
299       fetch_xtregs (regcache, regnum);
300     }
301   else if ((regnum < xtreg_lo) || (regnum > xtreg_high))
302     fetch_gregs (regcache, regnum);
303   else
304     fetch_xtregs (regcache, regnum);
305 }
306
307 static void
308 xtensa_linux_store_inferior_registers (struct target_ops *ops,
309                                        struct regcache *regcache, int regnum)
310 {
311   if (regnum == -1)
312     {
313       store_gregs (regcache, regnum);
314       store_xtregs (regcache, regnum);
315     }
316   else if ((regnum < xtreg_lo) || (regnum > xtreg_high))
317     store_gregs (regcache, regnum);
318   else
319     store_xtregs (regcache, regnum);
320 }
321
322 /* Called by libthread_db.  */
323
324 ps_err_e
325 ps_get_thread_area (struct ps_prochandle *ph,
326                     lwpid_t lwpid, int idx, void **base)
327 {
328   xtensa_elf_gregset_t regs;
329
330   if (ptrace (PTRACE_GETREGS, lwpid, NULL, &regs) != 0)
331     return PS_ERR;
332
333   /* IDX is the bias from the thread pointer to the beginning of the
334      thread descriptor.  It has to be subtracted due to implementation
335      quirks in libthread_db.  */
336   *base = (void *) ((char *) regs.threadptr - idx);
337
338   return PS_OK;
339 }
340
341 void _initialize_xtensa_linux_nat (void);
342
343 void
344 _initialize_xtensa_linux_nat (void)
345 {
346   struct target_ops *t;
347   const xtensa_regtable_t *ptr;
348
349   /* Calculate the number range for extended registers.  */
350   xtreg_lo = 1000000000;
351   xtreg_high = -1;
352   for (ptr = xtensa_regmap_table; ptr->name; ptr++)
353     {
354       if (ptr->gdb_regnum < xtreg_lo)
355         xtreg_lo = ptr->gdb_regnum;
356       if (ptr->gdb_regnum > xtreg_high)
357         xtreg_high = ptr->gdb_regnum;
358     }
359
360   /* Fill in the generic GNU/Linux methods.  */
361   t = linux_target ();
362
363   /* Add our register access methods.  */
364   t->to_fetch_registers = xtensa_linux_fetch_inferior_registers;
365   t->to_store_registers = xtensa_linux_store_inferior_registers;
366
367   linux_nat_add_target (t);
368 }